Contributing page

For general contributing guidelines, see the Contributing Guide on DoneJS.com.

Code Organization

bit-docs
└── package.json

Program Flow

When bit-docs gets run, the following flow happens:

  • bit-docs/bin/bit-docs is triggered, and passed command flags are parsed as options.
    • Next, the module export in main.js is called with the package.json path and options.
  • main.js uses lib/configure/configure.js to get a siteConfig which is passed to lib/generate/generate.js.
    • configure.js will install plugin packages defined in the bit-docs section of package.json.
    • Next, configure.js will allow each installed plugin to register itself to whatever handlers.
  • generate.js takes that configuration and passes it to those plugins registered as "generator" plugins.

Developing Locally

Setup

Fork and clone this repository. See Fork A Repo and Cloning a repository for help.

Install the packages defined in package.json:

npm install

Build

There is no build step for this repo.

Test

Tests are located in test.js, at the root of this repo.

Getting Help

Our forums and Gitter chat are the best places to ask questions.