0.8.0 • Published 5 years ago
react-docs-markdown v0.8.0
React Docs Markdown
At the moment this is a simple package, that takes the output from react-docgen, and returns it as Markdown. You can then save it to a file, append more content, or whatever you need.
API
docsToMarkdown(api: object, name: string, options: Object)
- api - The output from react-docgen.
- name - Component name to set as page title
- options (Optional)
- excludeKeys
- excludeTypes
- excludeDescription
Example
var fs = require('fs');
var docsToMarkdown = require('react-docs-markdown');
var md = docsToMarkdown(api, 'Button');
// Use fs to write the markdown to dist
fs.writeFile('docs/button.md', md, (err) => {
if (err) throw err;
});
Publishing
Use np when publishing a new version to ensure everything is done correctly.
0.8.0
5 years ago
0.7.0
6 years ago
0.6.3
6 years ago
0.6.2
6 years ago
0.6.1
6 years ago
0.6.0
6 years ago
0.5.0
7 years ago
0.4.1
7 years ago
0.4.0
7 years ago
0.3.4
7 years ago
0.3.3
7 years ago
0.3.2
7 years ago
0.3.1
7 years ago
0.3.0
7 years ago
0.2.0
7 years ago
0.1.8
7 years ago
0.1.7
7 years ago
0.1.6
7 years ago
0.1.5
8 years ago
0.1.4
8 years ago
0.1.3
8 years ago
0.1.2
8 years ago
0.1.1
8 years ago
0.1.0
8 years ago