https://github.com/metadoc/metadoc-md
Parse markdown code within description attributes of a https://github.com/metadoc/metadoc.js output file.
https://github.com/metadoc/metadoc-md
documentation generator markdown metadoc
Last synced: 11 months ago
JSON representation
Parse markdown code within description attributes of a https://github.com/metadoc/metadoc.js output file.
- Host: GitHub
- URL: https://github.com/metadoc/metadoc-md
- Owner: metadoc
- License: mit
- Created: 2018-08-27T20:22:36.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T23:51:44.000Z (over 3 years ago)
- Last Synced: 2025-03-27T09:42:03.091Z (about 1 year ago)
- Topics: documentation, generator, markdown, metadoc
- Language: JavaScript
- Homepage:
- Size: 1010 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# metadoc-md
This [metadoc](https://github.com/author/metadoc) post-processor will convert markdown, mermaid, or MathJax snippets within a metadoc's description attributes into HTML.
_Metadoc output before metadoc-md:_
_Metadoc output after metadoc-md:_
## Usage
This post-processor can be run standalone or as a part of a metadoc build process.
To run as a standalone CLI application, the utility must be installed globally:
`npm install -g @author.io/metadoc-md`
It can then be used from the command line:
```sh
metadoc-md --source /path/to/metadoc/api.json
```
Alternatively, it metadoc-md can be a part of a series of metadoc post-processors. In this scenario, the module should be saved as part of the `devDependencies`:
`npm install @author.io/metadoc-md --save-dev`
It can then be applied as a piped command to the metadoc generation process:
```sh
metadoc --source ./src --output ./docs --warnskippedevents --warnnocode --ignore ./work/in/progress | metadoc-md
```
## Additional Flags
_Common Flags:_
- `--output` Specify a custom output file (relative or absolute path).
_Boolean Flags:_
Each boolean flag (except `--output`) can receive a `true`/`false` value to enable/disable a feature. For example, to disable GFM, use `--gfm false`. If no value is supplied, it is assumed to be `true`. This means `--gfm` is the same as `--gfm true`.
- `--pedantic` Conform to the original markdown.pl as much as possible. Don't fix original markdown bugs or behavior. Turns off and overrides gfm.
- `--gfm` Apply [Github Flavored Markdown](https://github.github.com/gfm/). Enabled by default
- `--tables` When using `gfm`, use [GFM Tables extension](https://github.github.com/gfm/#tables-extension-). Enabled by default.
- `--breaks` If true, use GFM hard and soft line breaks. Requires `gfm` be true.
- `--smartlists` If true, use smarter list behavior than those found in markdown.pl.
- `--smartypants` If true, use "smart" typographic punctuation for things like quotes and dashes.
- `--xhtml` If true, emit self-closing HTML tags for void elements (
, ![]()
, etc.) with a "/" as required by XHTML.
- `--svg` Renders mermaid SVG files. See mermaid support secction below.
These features are all implemented by passing configuration values into [marked configuration options](https://marked.js.org/#/USING_ADVANCED.md#options).
## Mermaid Support
[Mermaid](https://github.com/knsv/mermaid) generates graphical SVG diagrams from text. It follows a markdown-like approach. metadoc-md identifies mermaid text and converts it to an HTML-friendly format.
For example:
_Metadoc output before metadoc-md:_
````
```mermaid
graph LR
a-->b;
b-->c;
```
````
_Metadoc output after metadoc-md:_
```html
graph LR
a-->b;
b-->c;
```
As shown above, metadoc-md identifies mermaid code and generates an HTML container for it with an automatic ID. However; it does not generate the SVG graphic. Mermaid provides a [browser library](https://www.jsdelivr.com/package/npm/mermaid) for this, which can parse the HTML and replace it with an SVG graphic. See the [usage instructions](https://mermaidjs.github.io/mermaidAPI.html)) for detail.
### Recognized Mermaid Types
- sequenceDiagram
- classDiagram
- graph (flowcharts)
- gitGraph
- gantt
## MathJAX Support
[MathJax](http://mathjax.org/) will generate equation displays from text. Metadoc-md identifies these equations using a markdown-like approach.
For example:
_Before metadoc-md:_
````
```math-tex
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
```
````
_After metadoc-md:_
```html
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
```
As shown above, metadoc-md identifies MathJax code and generates the HTML container for it. Notice the language is `math-tex`, indicating the equation content is LaTeX format. `math-inlinetex`, `math-asciimath`, and `math-mathml` are also supported by MathJax. However; metadoc-md does not generate any graphics. The [MathJax Getting Started Guide](https://www.mathjax.org/#gettingstarted) provides instructions for generating the graphics in the browser.