ignite

2019-10-10 admin

ignite是什么

什么是ignite,Modern markdown documentation generator

ignite使用教程帮助文档

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

<div align=“center”>

Ignite

Modern markdown documentation generation.

</div>

Usage

Head over to 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):

| <sub>Andrew Lisowski</sub> <g-emoji class=“g-emoji” alias=“computer” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png”>💻</g-emoji> <g-emoji class=“g-emoji” alias=“art” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png”>🎨</g-emoji> <g-emoji class=“g-emoji” alias=“book” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png”>📖</g-emoji> <g-emoji class=“g-emoji” alias=“bulb” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png”>💡</g-emoji> <g-emoji class=“g-emoji” alias=“thinking” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f914.png”>🤔</g-emoji> <g-emoji class=“g-emoji” alias=“metro” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f687.png”>🚇</g-emoji> <g-emoji class=“g-emoji” alias=“package” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png”>📦</g-emoji> <g-emoji class=“g-emoji” alias=“eyes” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f440.png”>👀</g-emoji> <g-emoji class=“g-emoji” alias=“warning” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/26a0.png”>⚠️</g-emoji> | <sub>Adam Dierkens</sub>

<g-emoji class=“g-emoji” alias=“computer” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png”>💻</g-emoji> <g-emoji class=“g-emoji” alias=“thinking” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f914.png”>🤔</g-emoji>

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

Awesome Plugins:

<g-emoji class=“g-emoji” alias=“star” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/2b50.png”>⭐️</g-emoji> Prop-Types - Takes a react component and displays a table with its prop-types.

<g-emoji class=“g-emoji” alias=“star” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/2b50.png”>⭐️</g-emoji> JSON Schema - Takes a JSON-Schema and exposes a Component that matches ids to auto-generate docs.

<g-emoji class=“g-emoji” alias=“rocket” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f680.png”>🚀</g-emoji> If you want to add your plugins to this list make a PR! <g-emoji class=“g-emoji” alias=“rocket” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f680.png”>🚀</g-emoji>

Gallery

<g-emoji class=“g-emoji” alias=“nail_care” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f485.png”>💅</g-emoji> Have some beautiful docs built using Ignite? Make a PR and feature them here <g-emoji class=“g-emoji” alias=“nail_care” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f485.png”>💅</g-emoji>

你可能感兴趣的文章:

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-77007.html

文章标题:ignite

回到顶部