This repository contains the source code for Blocknet's API documentation website.
Powered by Slate Docs.
Using Linux or MacOS:
# either run this to run locally
bundle install
bundle exec middleman server
# OR run this to run with vagrant
vagrant up
If you'd prefer to use Docker, instructions are available in the wiki.
You can now see the docs at http://localhost:4567. This will reload automatically when changes are saved.
- Syntax - These documents use Markdown syntax.
- Content - For better maintenance, the content is composed of separate files in
source/includes/
. Add new files to the docs by including the file name underincludes:
insource/index.html.md
. This also adds the content as a menu item. - Layout - The page template is managed with
source/layouts/layout.erb
andsource/stylesheets/
. - Formatting Conventions:
- Styling:
- Italics - Referencing menu/button text (Settings, Submit, Cancel, etc)
- Bold+Italics - Word emphasis (available balances)
inline code
- code, commands (servicenode list
), calls (dxGetOrders
), file contents (ExchangeWallets=
), state (finished
), parameters (dryrun
) , files (blocknetdx.conf
), directories (BlocknetDX/
)
- Naming:
- Parameters - Lowercase, underscores (correct:
order_id
,orderid
; incorrect:order id
,order-id
,orderID
)
- Parameters - Lowercase, underscores (correct:
- Spacing:
- 10 lines separating each call
- 2 lines separating each section within a call
- 2 lines separating response types
- Styling:
- Add notes to
source/includes/_changelog.md
.- Use the following header format:
M/D/YYY | ---------- |
- Replace
M/D/YYY
with the publishing date in said format. - See past changelog entries for reference.
- Use the following header format:
- Build the docs with the
bundle exec middleman build
command. - Deploy
build/
contents to staging site for testing. - Deploy
build/
contents to https://api.blocknet.co/.