Modern markdown documentation generator
Modern markdown documentation generation.
Head over to the full documentationfor a guide on getting started with Ignite.
To start developing Ignite, start up a terminal and run the following command. Be sure to restart the dev server when changing any non-React or non-markdown file, since webpack doesn't handle them.
yarn build:lib && yarn start
To debug your build run
Then use your favorite HTTP server to emulate a server environment.
python -m SimpleHTTPServer
NOTE: All urls are relative to
options.baseURL.Make sure to change baseURL if your website isn't served from '/'.
Releasing and publishing are handled automatically. Any time a PR is merged or code is pushed to master a new version of Ignite is released along with publishing a new version of the documentation to GitHub Pages.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributorsspecification. Contributions of any kind welcome!
:star: Prop-Types- Takes a react component and displays a table with its prop-types.
:star: JSON Schema- Takes a JSON-Schema and exposes a Component that matches ids to auto-generate docs.
:rocket: If you want to add your plugins to this list make a PR! :rocket:
:nail_care: Have some beautiful docs built using Ignite? Make a PR and feature them here :nail_care: