janryWang / Doc Scripts
Licence: mit
React Document Build Tool Scripts , Like react-scripts of create react app
Stars: β 149
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Doc Scripts
Awesome Documentation Tools
π₯ π All the tools, processes and resources you need to create an awesome API & Project documentation
Stars: β 138 (-7.38%)
Mutual labels: documentation-tool
Gestureai Coreml Ios
Hand-gesture recognition on iOS app using CoreML
Stars: β 145 (-2.68%)
Mutual labels: demo
Interactive Repulsive Effect
π« An interactive repulsion effect of grid items as seen in BestServedBold's Dribbble shot "Holographic-Interactions".
Stars: β 141 (-5.37%)
Mutual labels: demo
Low Rank Bilinear Pooling
Fine-grained classification via second order statistics in a compact end-to-end trainable model
Stars: β 145 (-2.68%)
Mutual labels: demo
Uitextviewdiyemojiexample
Example of insert custom emoji image in to UITextView. And get the represent string back after editing.
Stars: β 148 (-0.67%)
Mutual labels: demo
Segmentedcontrol
Android SegmentedControl + multi row support
Stars: β 143 (-4.03%)
Mutual labels: demo
Demo Reactive Spring
Demo code for "Servlet and Reactive Stacks" talk
Stars: β 147 (-1.34%)
Mutual labels: demo
Aspnetcore Angular Ngrx
π An ASP.NET Core WebAPI Demo with an Angular Client using Ngrx store and effects and Signalr
Stars: β 141 (-5.37%)
Mutual labels: demo
Gollum
A simple, Git-powered wiki with a sweet API and local frontend.
Stars: β 12,339 (+8181.21%)
Mutual labels: documentation-tool
Tcb Demo Basic
ε°η¨εΊΒ·δΊεΌεη³»εζη¨ββεΊη‘θ½εDEMO
Stars: β 140 (-6.04%)
Mutual labels: demo
Cocos Creator Joystick
πΉ Cocos Creator Joystick Demo θζζζ
Stars: β 148 (-0.67%)
Mutual labels: demo
Iconfontsimagelist
Components to simplify use of "Icon fonts": resize, color, opacity and more... with full support for High-DPI apps. Rendering optimized with GDI+
Stars: β 147 (-1.34%)
Mutual labels: demo
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
import {execute} from 'doc-scripts'
const options = {
title:'xxxx',
header:'<link rel="stylesheet" href="//xxxxxx">',
footer:'<script>xxxxx</script>',
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.
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.
<!-- this is doc-scripts.header.html -->
<link rel="stylesheet" href="//unpkg.com/@alifd/next/dist/next.min.css" />
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.
export default ({docs = []})=>(
<div>
<DocRenderer docs={docs}/>
</div>
)
Contributors πͺπ»
Janry π π» π π€ |
---|
LICENSE
Doc scripts is open source software licensed as MIT.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].