Skip to content

roaringUnicorn/typedoc-plugin-markdown-repro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Repro code for typedoc-plugin-markdown#286

The issue is about escaping the | char. Escaping works fine in arguments description, but not in type descriptions.

Generate documentation

To generate the documentation, use:

npm run doc-markdown

Using VuePress for a nice render

npm run vuepress

Once vuepress has finish building, doc can be accessed here:

  • Module: http://localhost:8080/modules.html
  • Interface: http://localhost:8080/interfaces/demoInterface.html

Result

Type description

The description of dataIDs is not fully rendered.

img.png

Argument description

Everything is fine here.

img_1.png

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published