## 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](https://codesandbox.io/) and iframe Support
## Install 🦅
```bash
npm install --save doc-scripts
```
## Usage 🌈
**1. Node cli**
```bash
doc-scripts start --input docs
doc-script build --input docs --output doc-site
```
**2. Markdown Usage**
[examples](./examples/README.md)
**3. Javascript api**
```javascript
import {execute} from 'doc-scripts'
const options = {
title:'xxxx',
header:'',
footer:'',
renderer:'./doc-renderer.js',
requires:[]
}
const webpackConfig = {
module:{
rules:[...]
}
}
execute('start',options,webpackConfig) or execute('build',options,webpackConfig)
```
**4. Webpack extended configuration**
Create a new file named doc-scripts.config.js in the root directory. The
following is the specific format specification.
```javascript
module.exports = {
module: {
rules: []
},
plugins: []
}
//or
module.exports = function(config) {
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.
```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.
```jsx
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.
export default ({docs = []})=>(
