All Projects β†’ jsdoc2md β†’ Jsdoc To Markdown

jsdoc2md / Jsdoc To Markdown

Licence: mit
Generate markdown documentation from jsdoc-annotated javascript

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Jsdoc To Markdown

Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (-76.15%)
Mutual labels:  documentation, documentation-tool, documentation-generator, markdown, generator
Pdoc
🐍 ➑️ πŸ“œ Auto-generate API documentation for Python projects
Stars: ✭ 604 (-49.62%)
Mutual labels:  api-documentation, documentation, documentation-tool, documentation-generator, generator
Drf Autodocs
Ultimately automated DRF documentation rendering(UNMAINTAINED)
Stars: ✭ 82 (-93.16%)
Mutual labels:  api-documentation, documentation, documentation-tool, documentation-generator
Compodoc
πŸ“” The missing documentation tool for your Angular, Nest & Stencil application
Stars: ✭ 3,567 (+197.5%)
Mutual labels:  documentation, documentation-tool, jsdoc, generator
Cgx
πŸ’»πŸ”₯CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
Stars: ✭ 190 (-84.15%)
Mutual labels:  documentation, documentation-generator, markdown, generator
Pdoc
API Documentation for Python Projects
Stars: ✭ 853 (-28.86%)
Mutual labels:  api-documentation, documentation, documentation-tool, documentation-generator
The Documentation Compendium
πŸ“’ Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+259.13%)
Mutual labels:  documentation, documentation-tool, readme
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (-63.14%)
Mutual labels:  documentation, markdown, generator
Parse Comments
Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.
Stars: ✭ 53 (-95.58%)
Mutual labels:  documentation, jsdoc, markdown
Docsify Tabs
A docsify.js plugin for rendering tabbed content from markdown
Stars: ✭ 65 (-94.58%)
Mutual labels:  documentation, markdown, generator
Daux.io
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.
Stars: ✭ 603 (-49.71%)
Mutual labels:  documentation-tool, documentation-generator, markdown
Zeal
Offline documentation browser inspired by Dash
Stars: ✭ 9,164 (+664.3%)
Mutual labels:  api-documentation, documentation, documentation-tool
Assemble
Community
Stars: ✭ 3,995 (+233.19%)
Mutual labels:  documentation, markdown, generator
Github Profile Readme Generator
πŸš€ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.
Stars: ✭ 7,812 (+551.54%)
Mutual labels:  readme, markdown, generator
Awesome Readme
A guide to writing an Awesome README. Read the full article in Towards Data Science.
Stars: ✭ 65 (-94.58%)
Mutual labels:  documentation, documentation-tool, readme
Docsify
πŸƒ A magical documentation site generator.
Stars: ✭ 19,310 (+1510.51%)
Mutual labels:  documentation, documentation-tool, markdown
Easybook
Book publishing as easy as it should be (built with Symfony components)
Stars: ✭ 744 (-37.95%)
Mutual labels:  documentation, markdown, generator
Devdocs
API Documentation Browser
Stars: ✭ 27,208 (+2169.22%)
Mutual labels:  api-documentation, documentation, documentation-tool
Markdown Guide
The comprehensive Markdown reference guide.
Stars: ✭ 835 (-30.36%)
Mutual labels:  documentation, documentation-tool, markdown
Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (-76.06%)
Mutual labels:  documentation, jsdoc, markdown

view on npm npm module downloads Gihub repo dependents Gihub package dependents Build Status Coverage Status js-standard-style Join the chat at https://gitter.im/jsdoc2md/jsdoc2md

Upgraders, please read the release notes

jsdoc-to-markdown

Generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.

Synopsis

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     |

Install

$ npm install --save-dev jsdoc-to-markdown

See also


Β© 2014-21 Lloyd Brookes <[email protected]>.

Tested by test-runner.

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].