Skip to content
Source code for Blocknet's API documentation: https://api.blocknet.co
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib initial commit Mar 6, 2019
source
.gitignore
Gemfile initial commit Mar 6, 2019
Gemfile.lock
LICENSE
README.md
config.rb
deploy.sh
font-selection.json

README.md

Blocknet API Documentation

This repository contains the source code for Blocknet's API documentation.

Powered by Slate Docs.

Getting Started

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.

Editing

  • 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 under includes: in source/index.html.md. This also adds the content as a menu item.
  • Layout - The page template is managed with source/layouts/layout.erb and source/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)
    • Spacing:
      • 10 lines separating each call
      • 2 lines separating each section within a call
      • 2 lines separating response types

See full wiki.

Publishing

  1. Add notes to source/includes/_changelog.md.
    1. Use the following header format:
      M/D/YYY    |
      ---------- |
      
    2. Replace M/D/YYY with the publishing date in said format.
    3. See past changelog entries for reference.
  2. Build the docs with the bundle exec middleman build command.
  3. Deploy build/ contents to staging site for testing.
  4. Deploy build/ contents to https://api.blocknet.co/.
You can’t perform that action at this time.