documentationjs / documentationjs/documentation

Plugin framework for documentation

Open
#1,441 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

Suggestion: Implement a plugin framework allowing to easily extend `documentation`

I have two distinct use cases for this:
* Being able to add a parser (for example C++) and to hook it in `buildInternal` along `parseJavaScript` and also in `isJSDocComment`
* Being able to support custom jsdoc tags - by plugging in the parser itself by tag name - as I have a very specific need, namely having a very large number of synchronous and asynchronous functions with the same parameters (+ callback for the async versions) that I need to be ideally able to document with a single block as to avoid any errors and render future maintenance easier

I am willing to work on an implementation if we can settle on a (somewhat) stable API

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.