Project Name | Stars | Downloads | Repos Using This | Packages Using This | Most Recent Commit | Total Releases | Latest Release | Open Issues | License | Language |
---|---|---|---|---|---|---|---|---|---|---|
Jsdoc To Markdown | 1,589 | 6,999 | 5,699 | 9 months ago | 118 | November 28, 2022 | 48 | mit | JavaScript | |
Generate markdown documentation from jsdoc-annotated javascript | ||||||||||
Gatsby Gitbook Starter | 957 | 7 months ago | 48 | mit | JavaScript | |||||
Generate GitBook style modern docs/tutorial websites using Gatsby + MDX | ||||||||||
Daux.io | 766 | 2 | 2 | 5 days ago | 53 | September 24, 2023 | 10 | mit | JavaScript | |
Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way. | ||||||||||
Pydoc Markdown | 422 | 54 | 63 | a month ago | 61 | June 26, 2023 | 25 | other | Python | |
Create Python API documentation in Markdown format. | ||||||||||
Doctave | 390 | a year ago | 20 | mit | Rust | |||||
A batteries-included developer documentation site generator | ||||||||||
Sourcedocs | 365 | 2 years ago | 11 | mit | Swift | |||||
Generate Markdown documentation from source code | ||||||||||
Markdown Blog | 353 | 24 days ago | 9 | May 20, 2023 | 9 | mit | Go | |||
🍭 Markdown-Blog 是一款小而美的Markdown静态博客程序 | Markdown-Blog is incredibly fast, easy to use, and converts Markdown formatted text files into beautifully rendered HTML pages. | ||||||||||
Badge Generator | 270 | a month ago | 78 | mit | TypeScript | |||||
Magically generate Markdown badges for your docs 🛡️ 🦡 🧙 | ||||||||||
Cgx | 250 | 3 | 4 months ago | 35 | July 24, 2023 | 1 | mit | TypeScript | ||
💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket) | ||||||||||
Docnet | 242 | 8 days ago | 10 | C# | ||||||
Your friendly static documentation generator, using markdown files to build the content. |
Upgraders, please read the release notes
Generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.
1. Document your code using valid jsdoc comments.
/**
* A quite wonderful function.
* @param {object} - Privacy gown
* @param {object} - Security
* @returns {survival}
*/
function protection (cloak, dagger) {}
2. Run a command.
$ jsdoc2md example.js
3. Get markdown output.
## protection(cloak, dagger) <code>survival</code>
A quite wonderful function.
**Kind**: global function
| Param | Type | Description |
| ------ | ------------------- | ------------ |
| cloak | <code>object</code> | Privacy gown |
| dagger | <code>object</code> | Security |
$ npm install --save-dev jsdoc-to-markdown
© 2014-23 Lloyd Brookes <[email protected]>.
Tested by test-runner.