Home

Awesome

CircleCI Codecov All Contributors npm npm code style: prettier Intuit Auto Release

<div align="center"> <a href="https://intuit.github.io/Ignite/"> <img width="250" height="250" src="./os-project-logo.svg"> </a> <h1> <a href="https://intuit.github.io/Ignite/"> Ignite </a> </h1> <p>Modern markdown documentation generation. </p> </div> <h2 align="center">Usage</h2>

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

<h2 align="center">Contributing</h2> <h3 align="center">Developing</h2>

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
<h3 align="center">Debugging</h3>

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

<h3 align="center">Publishing</h2>

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.

<p align="center"> <a href="https://github.com/intuit/Ignite/pulls">Pull Requests</a> welcome! Submit any bug report or feature enhancement as an <a href="https://github.com/intuit/Ignite/issues">issue</a>. </p>

Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore -->
<img src="https://avatars3.githubusercontent.com/u/1192452?v=4" width="100px;"/><br /><sub><b>Andrew Lisowski</b></sub><br />💻 🎨 📖 💡 🤔 🚇 📦 👀 ⚠️<img src="https://avatars1.githubusercontent.com/u/13004162?v=4" width="100px;"/><br /><sub><b>Adam Dierkens</b></sub><br />💻 🤔
<!-- ALL-CONTRIBUTORS-LIST:END -->

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

Awesome Plugins:

: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:

Gallery

:nail_care: Have some beautiful docs built using Ignite? Make a PR and feature them here :nail_care: