typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

MIT License

Downloads
1.6M
Stars
706
Committers
43
View Code on GitHub Visit Website
Ecosystems: GitLab, Markdown, TypeScript

Bot releases are hidden (Show)

typedoc-plugin-markdown - v2.2.0

Published by tgreyuk about 5 years ago

  • Updated theming model
  • Support for categorization
typedoc-plugin-markdown - v2.1.3

Published by tgreyuk about 5 years ago

  • Fixed #77 symbol references
typedoc-plugin-markdown - v2.1.2

Published by tgreyuk about 5 years ago

typedoc-plugin-markdown -

Published by tgreyuk about 5 years ago

  • #75 Links not Working when Displayed in Azure DevOps Wiki
typedoc-plugin-markdown - v2.1.0

Published by tgreyuk about 5 years ago

  • Added additional arguments
    • namedAnchors
    • hideBreadcrumbs
typedoc-plugin-markdown - v2.0.7

Published by tgreyuk over 5 years ago

  • Fixed #63 strips whitespace in fenced examples
  • Fixed #64 sign in title
  • Minor UI tweaks
typedoc-plugin-markdown - v2.0.6

Published by tgreyuk over 5 years ago

  • VuePress support
typedoc-plugin-markdown - v2.0.1 - v2.05

Published by tgreyuk over 5 years ago

  • Bug fixing / teething issues
typedoc-plugin-markdown - v2.0.0

Published by tgreyuk over 5 years ago

Overview

  • Refactored with several code and UI improvements
  • Zero dependancies

Non breaking changes

  • --mgEngine and --mdHideSources have been deprecated in favour of --platform and --hideSources

Breaking changes

  • --mdDcousaurus removed in favour of --platform docusaurus
  • --mdSoureRepo removed - the typedoc-plugin-sourcefile-url plugin offers similar functionality
typedoc-plugin-markdown - v1.2.1

Published by tgreyuk over 5 years ago

  • #55: Links not parsed in return comments.
typedoc-plugin-markdown - v1.2.0

Published by tgreyuk over 5 years ago

  • #54 Added support for optional Docusaurus formatting
typedoc-plugin-markdown - v1.1.26

Published by tgreyuk over 5 years ago

  • Additional fix to #50 (code block formatting).
typedoc-plugin-markdown - v1.1.27

Published by tgreyuk over 5 years ago

  • #52 Disable HTML escaping in inline code blocks
typedoc-plugin-markdown - v1.1.25

Published by tgreyuk over 5 years ago

  • Fixed comment tags layout (#50)
typedoc-plugin-markdown - v1.1.24

Published by tgreyuk almost 6 years ago

  • Escaped pipe character in comments (#49)
typedoc-plugin-markdown - v1.1.23

Published by tgreyuk almost 6 years ago

  • Escaped pipe character in type defs (#49)
typedoc-plugin-markdown - v1.1.22

Published by tgreyuk almost 6 years ago

  • FIxed rendering bug with Type Parameters (#48 )
typedoc-plugin-markdown - v1.1.21

Published by tgreyuk almost 6 years ago

  • Fixed typedoc 0.14.0 compatibility (#44)
typedoc-plugin-markdown - v1.1.20

Published by tgreyuk almost 6 years ago

  • Fixed #43 Properties with multiple allowable types render incorrectly
typedoc-plugin-markdown -

Published by tgreyuk almost 6 years ago

  • #42 links to identifiers differing only in case
Package Rankings
Top 1.11% on Npmjs.org
Badges
Extracted from project README
npm npm npm npm npm npm npm
Related Projects
markdown-magic

💫  Automatically format markdown files via comment blocks using source code, external data & cust...

30 Nov 2016 793
docma

A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown...

19 May 2016 334
typist

The mighty Tiptap-based rich-text editor that powers Doist products.

01 Nov 2022 371
graphql-markdown

Flexible GraphQL Documentation Generator (Markdown)

12 Jun 2020 130
markdownlint

A Node.js style checker and lint tool for Markdown/CommonMark files.

15 Mar 2015 4,509
react-markdown-preview

React component preview markdown text in web browser. The minimal amount of CSS to replicate the ...

18 Apr 2020 273
doxdox

📘 JSDoc to Markdown, Bootstrap, and custom JavaScript template documentation generator.

02 Aug 2014 161
jsx-readme

Generate Readme files with a React-like syntax and package.json-aware helpers.

08 Sep 2020 15
academic-pandoc-template

Write beautifully typeset academic texts with distraction-free Markdown and Pandoc.

04 Jul 2018 220
markdown-it-typst

Plugin to transform Typst code to SVG image for markdown-it markdown parser.

16 Sep 2024 3
agentmarkdown

An accurate, extensible, and fast HTML-to-markdown converter.

24 Jun 2019 9
editor.md

The open source embeddable online markdown editor (component).

01 Feb 2015 13,606