ignite

Modern markdown documentation generator

Ignite

Modern markdown documentation generation.

Usage

Head over to the full documentationfor 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 Requestswelcome! 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-contributorsspecification. 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:

Repository

https://github.com/intuit/Ignite/


上一篇:stylelint-csstree-validator
下一篇:i18n-extractor

相关推荐

  • viur-ignite-css

    Core of VIUR Ignite a less framework npm version(https://badge.fury.io/js/viurignitecss.svg)(https...

    6 个月前
  • igniteui-cli

    CLI tool for creating Ignite UI projects igniteuicli The allows you to easily generate projects ...

    6 个月前
  • igniteui-angular

    Ignite UI for Angular is a dependencyfree Angular toolkit for building modern web apps Ignite UI f...

    6 个月前
  • Style alignItems 属性

    Style 对象 实例 居中对齐灵活的 <div> 元素的各项: document.getElementById("myDIV").style.alignItems="center";...

    1 年前

官方社区

扫码加入 JavaScript 社区