Modern markdown documentation generator
Clone or download
Latest commit e4ba60b Nov 20, 2018

README.md

CircleCI Codecov All Contributors npm npm code style: prettier Intuit

Ignite

Modern markdown documentation generation.

Usage

Head over the the full documentation for a guide on getting started with Ignite.

Contributing

Developing

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

Debugging

To debug your build run

yarn build

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 '/'.

Publishing

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.

Pull Requests welcome! Submit any bug report or feature enhancement as an issue.

Contributors

Thanks goes to these wonderful people (emoji key):


Andrew Lisowski

πŸ’» 🎨 πŸ“– πŸ’‘ πŸ€” πŸš‡ πŸ“¦ πŸ‘€ ⚠️

Adam Dierkens

πŸ’» πŸ€”

This project follows the all-contributors specification. Contributions of any kind welcome!

Awesome Plugins:

⭐️ Prop-Types - Takes a react component and displays a table with it's prop-types.

⭐️ JSON Schema - Takes a JSON-Schema and exposes a Component that matches ids to auto-generate docs.

πŸš€ If you want to add your plugins to this list make a PR! πŸš€

Gallary

πŸ’… Have some beatiful docs built using Ignite? Make a PR and feature them here πŸ’…