https://github.com/intuit/Ignite

Modern markdown documentation generator
https://github.com/intuit/Ignite

documentation-tool markdown

Last synced: 4 months ago
JSON representation

Modern markdown documentation generator

• Host: GitHub
• URL: https://github.com/intuit/Ignite
• Owner: intuit
• License: apache-2.0
• Archived: true
• Created: 2018-07-02T14:47:11.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-15T18:54:11.000Z (over 1 year ago)
• Last Synced: 2024-09-19T14:12:42.948Z (5 months ago)
• Topics: documentation-tool, markdown
• Language: JavaScript
• Homepage: https://intuit.github.io/Ignite/
• Size: 8.37 MB
• Stars: 103
• Watchers: 6
• Forks: 30
• Open Issues: 56
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CircleCI](https://img.shields.io/circleci/project/github/intuit/Ignite/master.svg?style=for-the-badge)](https://circleci.com/gh/intuit/Ignite) [![Codecov](https://img.shields.io/codecov/c/github/intuit/ignite.svg?style=for-the-badge)](https://codecov.io/gh/intuit/ignite)

[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=for-the-badge)](#contributors)

[![npm](https://img.shields.io/npm/v/ignite.svg?style=for-the-badge)](https://www.npmjs.com/package/ignite)

[![npm](https://img.shields.io/npm/dt/ignite.svg?style=for-the-badge)](https://www.npmjs.com/package/ignite) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier) [![Intuit](https://img.shields.io/badge/Created%20by-Intuit-blue.svg?style=for-the-badge)](https://www.intuit.com/) [![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAACzElEQVR4AYXBW2iVBQAA4O+/nLlLO9NM7JSXasko2ASZMaKyhRKEDH2ohxHVWy6EiIiiLOgiZG9CtdgG0VNQoJEXRogVgZYylI1skiKVITPTTtnv3M7+v8UvnG3M+r7APLIRxStn69qzqeBBrMYyBDiL4SD0VeFmRwtrkrI5IjP0F7rjzrSjvbTqwubiLZffySrhRrSghBJa8EBYY0NyLJt8bDBOtzbEY72TldQ1kRm6otana8JK3/kzN/3V/NBPU6HsNnNlZAz/ukOalb0RBJKeQnykd7LiX5Fp/YXuQlfUuhXbg8Di5GL9jbXFq/tLa86PpxPhAPrwCYaiorS8L/uuPJh1hZFbcR8mewrx0d7JShr3F7pNW4vX0GRakKWVk7taDq7uPvFWw8YkMcPVb+vfvfRZ1i7zqFwjtmFouL72y6C/0L0Ie3GvaQXRyYVB3YZNE32/+A/D9bVLcRB3yw3hkRCdaDUtFl6Ykr20aaLvKoqIXUdbMj6GFzAmdxfWx9iIRrkDr1f27cFONGMUo/gRI/jNbIMYxJOoR1cY0OGaVPb5z9mlKbyJP/EsdmIXvsFmM7Ql42nEblX3xI1BbYbTkXCqRnxUbgzPo4T7sQBNeBG7zbAiDI8nWfZDhQWYCG4PFr+HMBQ6l5VPJybeRyJXwsdYJ/cRnlJV0yB4ZlUYtFQIkMZnst8fRrPcKezHCblz2IInMIkPzbbyb9mW42nWInc2xmE0y61AJ06oGsXL5rcOK1UdCbEXiVwNXsEy/6+EbaiVG8eeEAfxvaoSBnCH61uOD7BS1Ul8ESHBKWxCrdyd6EYNKihgEVrwOAbQruoytuBYIFfAc3gVN6iawhjKyNCEpYhVJXgbOzARyaU4hCtYizq5EI1YgiUoIlT1B7ZjByqmRWYbwtdYjoWoN7+LOIQefIqKawLzK6ID69GGpQgwhhEcwGGUzfEPAiPqsCXadFsAAAAASUVORK5CYII=)](https://github.com/intuit/auto-release)



  

    

  

  


    

      Ignite

    

  

  
Modern markdown documentation generation. 



Usage


Head over to the full [documentation](https://intuit.github.io/Ignite/) 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.

```bash

yarn build:lib && yarn start

```

Debugging


To debug your build run

```bash

yarn build

```

Then use your favorite HTTP server to emulate a server environment.

```bash

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](https://github.com/kentcdodds/all-contributors#emoji-key)):

| [
Andrew Lisowski](http://hipstersmoothie.com)
[💻](https://github.com/Intuit/Ignite/commits?author=hipstersmoothie "Code") [🎨](#design-hipstersmoothie "Design") [📖](https://github.com/Intuit/Ignite/commits?author=hipstersmoothie "Documentation") [💡](#example-hipstersmoothie "Examples") [🤔](#ideas-hipstersmoothie "Ideas, Planning, & Feedback") [🚇](#infra-hipstersmoothie "Infrastructure (Hosting, Build-Tools, etc)") [📦](#platform-hipstersmoothie "Packaging/porting to new platform") [👀](#review-hipstersmoothie "Reviewed Pull Requests") [⚠️](https://github.com/Intuit/Ignite/commits?author=hipstersmoothie "Tests") | [
Adam Dierkens](https://adamdierkens.com)
[💻](https://github.com/Intuit/Ignite/commits?author=adierkens "Code") [🤔](#ideas-adierkens "Ideas, Planning, & Feedback") |

| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

## Awesome Plugins:

:star: [Prop-Types](https://github.com/hipstersmoothie/ignite-plugin-prop-types) - Takes a react component and displays a table with its prop-types.

:star: [JSON Schema](https://github.com/hipstersmoothie/ignite-plugin-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: