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 - v1.1.18

Published by tgreyuk almost 6 years ago

  • Updated paramter table column header from 'Param' to 'Name'
typedoc-plugin-markdown - v1.1.17

Published by tgreyuk about 6 years ago

  • Fixed #35: gitbook index visibility
typedoc-plugin-markdown - v1.1.16

Published by tgreyuk about 6 years ago

  • Fixed #39: Added support for _namedParameters
typedoc-plugin-markdown - v1.1.15

Published by tgreyuk about 6 years ago

  • #38 Formatting of interface generic method is unclear.
typedoc-plugin-markdown - v1.1.14

Published by tgreyuk about 6 years ago

  • #37 Change type alias prefix symbol and formatting to avoid confusion
typedoc-plugin-markdown - v1.1.13

Published by tgreyuk over 6 years ago

  • #33 Plugin already loaded error(s)
typedoc-plugin-markdown - v1.1.12

Published by tgreyuk over 6 years ago

  • Fixed #32 node 6 support
typedoc-plugin-markdown - v1.1.11

Published by tgreyuk over 6 years ago

  • #31 Fix bitbucket sourcefile url
typedoc-plugin-markdown - v1.1.10

Published by tgreyuk over 6 years ago

  • Fixed #29: Compilation error when all children are hidden.
typedoc-plugin-markdown - v1.1.9

Published by tgreyuk over 6 years ago

  • Fix #27 Broken parameter table when function has a parameter with different types.
typedoc-plugin-markdown - v1.1.8

Published by tgreyuk over 6 years ago

  • Correct turndown configuration #25
typedoc-plugin-markdown - v1.1.7

Published by tgreyuk over 6 years ago

  • Make turndown default to using fenced code blocks #24
typedoc-plugin-markdown - v1.1.6

Published by tgreyuk over 6 years ago

  • Fixed #22 "Handling generic types"
typedoc-plugin-markdown - v1.1.5

Published by tgreyuk over 6 years ago

  • Fixed #21 "Handling generic types"
  • Added flags to params and refactored param table headers
  • Fixed issue with members not displaying in index
typedoc-plugin-markdown - v1.1.3

Published by tgreyuk over 6 years ago

  • Cleaned up interface properties layout
typedoc-plugin-markdown - v1.1.2

Published by tgreyuk over 6 years ago

  • Reduced whitespace of output
typedoc-plugin-markdown - v1.1.1

Published by tgreyuk over 6 years ago

  • Updated GitBook output to take account of sub-navigation generation.
typedoc-plugin-markdown - v1.1.0

Published by tgreyuk over 6 years ago

  • Added 'gitbook' flavour option that add a SUMMARY.md file to generate a book's table of contents
typedoc-plugin-markdown - v1.0.15

Published by tgreyuk over 6 years ago

  • Updated packages
typedoc-plugin-markdown - v1.0.14

Published by tgreyuk over 6 years ago

  • Updated packages and readme. No code changes.
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
jsx-readme

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

08 Sep 2020 15
editor.md

The open source embeddable online markdown editor (component).

01 Feb 2015 13,606
markdown-it-typst

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

16 Sep 2024 3
docma

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

19 May 2016 334
agentmarkdown

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

24 Jun 2019 9
graphql-markdown

Flexible GraphQL Documentation Generator (Markdown)

12 Jun 2020 130
typist

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

01 Nov 2022 371
academic-pandoc-template

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

04 Jul 2018 220
doxdox

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

02 Aug 2014 161
react-markdown-preview

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

18 Apr 2020 273
markdownlint

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

15 Mar 2015 4,509