Features 🦑
- 🛠 No config
- 😆 Based on Markdown,Merge and Show all markdown files
- 👩💻 Code Highlighting And JSX Code is Runnable
- 💯 Emoji Support
- 🍖 React Props Table Support
- ✨ Creates Static files (only JS is prism)
- 🏳️🌈 Pretty Pages
- 🦄 Customizable
- 🇳🇱 CodeSandbox and iframe Support
Install 🦅
npm install --save doc-scripts
Usage 🌈
1. Node cli
doc-scripts start --input docs doc-script build --input docs --output doc-site
2. Markdown Usage
3. Javascript api
const options = title:'xxxx' header:'<link rel="stylesheet" href="//xxxxxx">' footer:'<script>xxxxx</script>' renderer:'./doc-renderer.js' requires: const webpackConfig = module: rules:... or
4. Webpack extended configuration
Create a new file named doc-scripts.config.js in the root directory. The following is the specific format specification.
moduleexports = module: rules: plugins: //or module { return ...config module: rules: plugins: }
5. Demo HTML Template extended configuration
Create a new file named doc-scripts.header.html or doc-scripts.footer.html in the root directory. The following is the specific format specification.
<!-- this is doc-scripts.header.html -->
6. Customize Doc Renderer
Create a new file named doc-scripts.renderer.js in the root directory. The following is the specific format specification.
import DocRenderer from 'react-doc-renderer' //react-doc-renderer default render engien in doc-scripts, so ,you can continue to reuse this component in doc-scripts.renderer.js, or you can completely override its behavior. docs = <div> <DocRenderer =/> </div>
Contributors 💪🏻
Janry 📖 💻 👀 🤔 |
---|
LICENSE
Doc scripts is open source software licensed as MIT.