typedoc-plugin-markdown

Generates TypeScript API documentation as Markdown.

MIT 269 个版本

documentation markdown typedoc typescript typedoc-plugin

主页

仓库

提交 Issue

安装

npm install typedoc-plugin-markdown

yarn add typedoc-plugin-markdown

pnpm add typedoc-plugin-markdown

bun add typedoc-plugin-markdown

README

typedoc-plugin-markdown

Overview

TypeDoc generates API documentation for TypeScript projects as HTML by default. This plugin adds Markdown output that can be easily integrated into different ecosystems, such as code repositories, wikis, and static site generators.

Installation

npm install typedoc typedoc-plugin-markdown --save-dev

Features

Generates CommonMark, GFM, and MDX-compatible Markdown from TypeDoc projects.
Works alongside other TypeDoc plugins.
Configurable output structure.
Companion plugins for frontmatter and remark transforms.
Companion themes for Docusaurus, VitePress, GitHub Wiki, and GitLab Wiki workflows.

Documentation

See the documentation for installation, configuration options, and usage guides.

Examples

See the examples repository for generated output and publishing examples.

License

MIT

版本列表

4.12.0 2026-06-02

4.11.0 2026-03-18

4.10.0 2026-02-06

4.9.0 2025-09-19

4.8.1 2025-08-11

4.8.0 2025-07-29

4.7.1 2025-07-19

4.7.0 2025-06-20

4.6.4 2025-06-01

4.6.3 2025-04-23

4.6.2 2025-04-09

4.6.1 2025-04-02

4.6.0 2025-03-23

4.5.2 2025-03-19

4.5.1 2025-03-18

4.5.0 2025-03-16

4.4.2 2025-02-09

4.4.1 2025-01-01

4.4.0 2024-12-30

4.3.3 2024-12-18

4.3.2 2024-12-08

4.3.1 2024-12-01

4.3.0 2024-11-27

4.2.10 2024-11-01

4.2.9 2024-10-01

4.2.8 2024-09-22

4.2.7 2024-09-05

4.2.6 2024-08-25

4.2.5 2024-08-15

4.2.4 2024-08-13

4.2.3 2024-07-24

4.2.2 2024-07-22

4.2.1 2024-07-11

4.2.0 2024-07-10

4.1.2 2024-07-05

4.1.1 2024-06-30

4.1.0 2024-06-22

4.0.3 2024-05-27

4.0.2 2024-05-15

4.0.1 2024-05-06

4.0.0 2024-05-03

4.0.0-next.60 2024-04-29

4.0.0-next.59 2024-04-28

4.0.0-next.58 2024-04-21

4.0.0-next.57 2024-04-20

4.0.0-next.56 2024-04-19

4.0.0-next.55 2024-04-05

4.0.0-next.54 2024-03-21

4.0.0-next.53 2024-02-08

4.0.0-next.52 2024-02-07

4.0.0-next.51 2024-02-07

4.0.0-next.50 2024-02-02

4.0.0-next.49 2024-02-01

4.0.0-next.48 2024-02-01

4.0.0-next.47 2024-01-31

4.0.0-next.46 2024-01-30

4.0.0-next.45 2024-01-30

4.0.0-next.44 2024-01-30

4.0.0-next.43 2024-01-18

4.0.0-next.42 2024-01-18

4.0.0-next.41 2024-01-18

4.0.0-next.40 2024-01-12

4.0.0-next.39 2024-01-05

4.0.0-next.38 2023-12-18

4.0.0-next.37 2023-12-15

4.0.0-next.36 2023-12-03

4.0.0-next.35 2023-12-01

4.0.0-next.34 2023-11-30

4.0.0-next.33 2023-11-30

4.0.0-next.32 2023-11-29

4.0.0-next.31 2023-11-24

4.0.0-next.30 2023-11-20

4.0.0-next.29 2023-11-19

4.0.0-next.28 2023-11-18

4.0.0-next.27 2023-11-07

4.0.0-next.26 2023-11-07

4.0.0-next.25 2023-10-28

4.0.0-next.24 2023-10-20

4.0.0-next.23 2023-10-09

4.0.0-next.22 2023-09-26

4.0.0-next.21 2023-09-25

4.0.0-next.20 2023-08-29

4.0.0-next.19 2023-08-27

4.0.0-next.18 2023-08-10

4.0.0-next.17 2023-07-07

4.0.0-next.16 2023-06-13

4.0.0-next.15 2023-06-13

4.0.0-next.14 2023-06-12

4.0.0-next.13 2023-05-26

4.0.0-next.12 2023-05-17

4.0.0-next.11 2023-05-13

4.0.0-next.10 2023-04-26

4.0.0-next.9 2023-04-25

4.0.0-next.8 2023-04-21

4.0.0-next.7 2023-04-18

4.0.0-next.6 2023-04-16

4.0.0-next.5 2023-04-14

4.0.0-next.4 2023-04-11

4.0.0-next.3 2023-02-04

4.0.0-next.2 2023-01-30

4.0.0-next.1 2023-01-29

4.0.0-next.0 2023-01-22

3.17.1 2023-11-06

3.17.0 2023-11-01

3.16.0 2023-08-25

3.15.4 2023-07-24

3.15.3 2023-04-29

3.15.2 2023-04-20

3.15.1 2023-04-11

3.15.0 2023-04-11

3.14.0 2022-12-02

3.13.6 2022-09-04

3.13.5 2022-08-30

3.13.4 2022-07-21

3.13.3 2022-07-05

3.13.2 2022-06-30

3.13.1 2022-06-28

3.13.0 2022-06-28

3.12.1 2022-04-21

3.12.0 2022-04-09

3.11.14 2022-02-14

3.11.13 2022-02-05

3.11.12 2022-01-18

3.11.11 2022-01-09

3.11.10 2022-01-09

3.11.9 2022-01-05

3.11.8 2021-12-17

3.11.7 2021-11-20

3.11.6 2021-11-14

3.11.5 2021-11-12

3.11.4 2021-11-12

3.11.3 2021-10-05

3.11.2 2021-09-25

3.11.1 2021-09-23

3.11.0 2021-09-15

3.10.4 2021-07-20

3.10.3 2021-07-13

3.10.2 2021-06-24

3.10.1 2021-06-23

3.10.0 2021-06-18

3.9.0 2021-06-01

3.8.2 2021-05-26

3.8.1 2021-05-11

3.8.0 2021-05-05

3.7.2 2021-04-25

3.7.1 2021-04-18

3.7.0 2021-04-17

3.6.1 2021-04-05

3.6.0 2021-02-27

3.5.0 2021-02-15

3.4.5 2021-01-26

3.4.4 2021-01-26

3.4.3 2021-01-22

3.4.2 2021-01-21

3.4.1 2021-01-19

3.4.0 2021-01-06

3.3.0 2021-01-05

3.2.1 2020-12-29

3.2.0 2020-12-29

3.1.1 2020-12-10

3.1.0 2020-12-08

3.0.11 2020-10-20

3.0.10 2020-10-16

3.0.9 2020-10-13

3.0.8 2020-10-10

3.0.7 2020-10-04

3.0.6 2020-10-04

3.0.5 2020-10-02

3.0.4 2020-10-01

3.0.3 2020-09-25

3.0.2 2020-09-19

3.0.1 2020-09-19

3.0.0 2020-09-18

2.4.2 2020-08-24

2.4.1 2020-08-17

2.4.0 2020-08-01

2.3.2 2020-07-31

2.3.1 2020-06-04

2.3.0 2020-06-02

2.2.17 2020-02-25

2.2.16 2020-01-06

2.2.15 2020-01-06

2.2.14 2019-12-05

2.2.13 2019-12-05

2.2.12 2019-12-05

2.2.11 2019-10-15

2.2.10 2019-10-07

2.2.9 2019-10-07

2.2.8 2019-10-05

2.2.7 2019-09-27

2.2.6 2019-09-19

2.2.5 2019-09-18

2.2.4 2019-09-17

2.2.3 2019-09-16

2.2.2 2019-09-15

2.2.1 2019-09-12

2.2.0 2019-09-12

2.1.12 2019-09-12

2.1.11 2019-09-08

2.1.10 2019-09-04

2.1.9 2019-09-02

2.1.8 2019-09-02

2.1.7 2019-08-31

2.1.6 2019-08-31

2.1.5 2019-08-31

2.1.4 2019-08-27

2.1.3 2019-08-18

2.1.2 2019-08-17

2.1.1 2019-08-03

2.1.0 2019-07-26

2.0.11 2019-07-22

2.0.10 2019-07-17

2.0.9 2019-07-12

2.0.8 2019-07-01

2.0.7 2019-06-28

2.0.6 2019-06-21

2.0.5 2019-06-20

2.0.4 2019-06-17

2.0.3 2019-06-17

2.0.2 2019-06-17

2.0.1 2019-06-17

2.0.0 2019-06-16

1.2.1 2019-05-15

1.2.0 2019-04-11

1.1.27 2019-02-24

1.1.26 2019-02-06

1.1.25 2019-01-26

1.1.24 2019-01-24

1.1.23 2019-01-23

1.1.22 2019-01-18

1.1.21 2019-01-05

1.1.20 2018-12-22

1.1.19 2018-11-17

1.1.18 2018-10-27

1.1.17 2018-10-09

1.1.16 2018-10-01

1.1.15 2018-08-28

1.1.14 2018-08-23

1.1.13 2018-06-04

1.1.12 2018-05-22

1.1.11 2018-05-18

1.1.10 2018-05-17

1.1.9 2018-05-16

1.1.8 2018-05-09

1.1.7 2018-05-08

1.1.6 2018-04-25

1.1.5 2018-04-24

1.1.4 2018-04-17

1.1.3 2018-04-17

1.1.2 2018-04-16

1.1.1 2018-04-14

1.1.0 2018-04-02

1.0.15 2018-03-30

1.0.14 2018-02-14

1.0.13 2018-02-13

1.0.12 2017-12-28

1.0.11 2017-10-06

1.0.10 2017-09-29

1.0.9 2017-09-28

1.0.8 2017-08-21

1.0.7 2017-08-18

1.0.6 2017-07-25

1.0.5 2017-07-25

1.0.4 2017-07-17

1.0.3 2017-07-17

1.0.2 2017-06-29

1.0.1 2017-06-29

1.0.0 2017-06-29

0.0.12 2017-06-20