3.17.1 • Published 3 days ago

typedoc-plugin-markdown v3.17.1

Weekly downloads
47,495
License
MIT
Repository
github
Last release
3 days ago

typedoc-plugin-markdown

A plugin for TypeDoc that renders TypeScript API documentation as Markdown.

npm Build Status

What it does?

The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options.

Useful if documentation is required to be included in project README files, Wikis and static site generators.

Installation

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

Usage

Usage is the same as documented at TypeDoc.

typedoc --plugin typedoc-plugin-markdown

The --plugin arg is optional (all plugins are loaded by default), however if using with the default html theme, use --plugin none to switch the plugin off.

Options

The following options can be used in addition to relevant TypeDoc options (please note that TypeDoc options specific to the HTML theme will be ignored).

File output options

See File output options for further documentation.

  • --entryDocument The file name of the entry document. Defaults to README.md.
  • --symbolsWithOwnFile Determines which symbols should be written to their own file. Expected values none, all OR Array of class, interface, enum, function, var, type Defaults to all (all symbols exported to an individual file).
  • --fileStructure Specifies how the files should be generated, grouped by modules or symbol types. Expected values modules, symbols. Defaults to modules.

UI options

  • --hideBreadcrumbs Do not print breadcrumbs header. Defaults to false.
  • --hideInPageTOC Do not print in-page index items. Defaults to false.
  • --hidePageTitle Do not print the page title. Defaults to false.
  • --hideHierarchy Do not print reflection hierarchy. Defaults to false.

Utility options

  • --namedAnchors Use HTML named anchors tags for implementations that do not assign header ids. Defaults to false.
  • --publicPath Specify the base path for all urls. If undefined urls will be relative. Defaults to .

Documentation

License

MIT

markdowntypescriptdocumentationapitypedocplugintypedoc
@mbenko/web-formobsidianlinkthedatabasesxsj-dev@newhorizon-tech/dd-npm-package-templateobj-ui@everything-registry/sub-chunk-2994@ikari-engine/plugoutsgros-clientimproved-localstoragefluxpaymentsexample-sum-hminhthunode-poe-apinpm-tea-campaignnode-extendedpine-utilsmongo-baseopsprotocol-js-sdkquickdoctest-typescript-generatortrustlines-clientlibtoucan-sdktypecheck-utilstypedoc-ember-themetypedoc-exposed-plugintypedoc-frontmatter-themetypedoc-wikijs-themetypedoc-theme-qbtypedoc-storybook-themetypedoc-storybook-theme-v2ufo-sdkufogees-sdkufomarketplace-sdkufomarketplace-sdk-newufosupergalatic-sdkspoken-pressagiosum-dangtthuynhisum-mlbonessologenic-xrpl-stream-jssologenic-xrpl-stream-js-appsologenic-xrpl-stream-js-devsologenic-xrpl-stream-js-nextsologenic-xrpl-stream-js-nightlysxsjsxsj-appsxsj-nexttbdocs-action-draft@mapeo/schema@plugnet/dev@pepfar-react-lib/jest-tools@pstehlik/dharma.jsyilia-wang@qodly/docs@rwsdatalab/typedoc-storybook-theme@reins-pro/docgen@rapidajs/postprocessing@rapidajs/rapida@rapidajs/recs@rapidajs/three@nwt/conductor-javascript@robbie-cook/node-helperuser-login-moduleut-registration-api@ouc/docusaurus-plugin@patract/dev@modern-js/doc-plugin-typedoc@lottiefiles/lottie-js@oodletech/oodle-js@open-web3/dev-config@io-orkes/conductor-typescript@handy-common-utils/dev-utils@infinitebrahmanuniverse/nolb-typedsnowdev@nagat/dharma.js@oasis-engine/asset-tools@rspress/plugin-typedoc@terascope/scriptsweather-app-teawaline-web3wv-linewise-js-libxmgisopengisxmgissupermap@jorsek/content-portal-configs@jorsek/content-portal-themes@kimafinance/kima-transaction-widget@imtiazchowdhury/base-crud@jacktanws/web3-kit@612zyn289/teaproject@0x/ts-doc-gen@sundaeswap/docgen@usecannon/builder@ta-interaktiv/webpack-config@symbiont-io/assembly-client@typescript-runtime-schema/generate-docs@tangten/tea-cake@site0/tijs@xhubio/build-base@tetcoin/dev@terryweiss/cosmostream@streamhive/quick-pack
4.0.0-next.60

3 days ago

4.0.0-next.59

4 days ago

4.0.0-next.58

11 days ago

4.0.0-next.57

12 days ago

4.0.0-next.56

13 days ago

4.0.0-next.55

27 days ago

4.0.0-next.54

1 month ago

4.0.0-next.51

3 months ago

4.0.0-next.52

3 months ago

4.0.0-next.53

3 months ago

4.0.0-next.50

3 months ago

4.0.0-next.48

3 months ago

4.0.0-next.49

3 months ago

4.0.0-next.47

3 months ago

4.0.0-next.44

3 months ago

4.0.0-next.45

3 months ago

4.0.0-next.46

3 months ago

4.0.0-next.41

3 months ago

4.0.0-next.42

3 months ago

4.0.0-next.43

3 months ago

4.0.0-next.40

4 months ago

4.0.0-next.39

4 months ago

4.0.0-next.38

5 months ago

4.0.0-next.37

5 months ago

4.0.0-next.30

5 months ago

4.0.0-next.33

5 months ago

4.0.0-next.34

5 months ago

4.0.0-next.31

5 months ago

4.0.0-next.32

5 months ago

4.0.0-next.35

5 months ago

4.0.0-next.36

5 months ago

4.0.0-next.28

6 months ago

4.0.0-next.29

5 months ago

4.0.0-next.26

6 months ago

4.0.0-next.27

6 months ago

4.0.0-next.24

6 months ago

4.0.0-next.25

6 months ago

3.17.0

6 months ago

3.17.1

6 months ago

4.0.0-next.22

7 months ago

4.0.0-next.23

7 months ago

4.0.0-next.20

8 months ago

4.0.0-next.21

7 months ago

4.0.0-next.15

11 months ago

4.0.0-next.16

11 months ago

4.0.0-next.13

11 months ago

4.0.0-next.14

11 months ago

4.0.0-next.19

8 months ago

4.0.0-next.17

10 months ago

4.0.0-next.18

9 months ago

3.15.4

9 months ago

3.16.0

8 months ago

4.0.0-next.11

12 months ago

4.0.0-next.12

12 months ago

4.0.0-next.10

1 year ago

4.0.0-next.9

1 year ago

4.0.0-next.8

1 year ago

4.0.0-next.7

1 year ago

4.0.0-next.6

1 year ago

4.0.0-next.1

1 year ago

4.0.0-next.0

1 year ago

4.0.0-next.5

1 year ago

4.0.0-next.4

1 year ago

4.0.0-next.3

1 year ago

4.0.0-next.2

1 year ago

3.15.0

1 year ago

3.15.2

1 year ago

3.15.1

1 year ago

3.15.3

1 year ago

3.14.0

1 year ago

3.13.6

2 years ago

3.13.5

2 years ago

3.13.2

2 years ago

3.13.1

2 years ago

3.13.4

2 years ago

3.13.3

2 years ago

3.13.0

2 years ago

3.12.1

2 years ago

3.12.0

2 years ago

3.11.8

2 years ago

3.11.9

2 years ago

3.11.11

2 years ago

3.11.10

2 years ago

3.11.13

2 years ago

3.11.12

2 years ago

3.11.14

2 years ago

3.11.4

2 years ago

3.11.6

2 years ago

3.11.5

2 years ago

3.11.7

2 years ago

3.11.3

3 years ago

3.11.2

3 years ago

3.11.1

3 years ago

3.11.0

3 years ago

3.10.4

3 years ago

3.10.3

3 years ago

3.10.1

3 years ago

3.10.2

3 years ago

3.10.0

3 years ago

3.9.0

3 years ago

3.8.2

3 years ago

3.7.2

3 years ago

3.8.0

3 years ago

3.8.1

3 years ago

3.7.1

3 years ago

3.7.0

3 years ago

3.6.1

3 years ago

3.6.0

3 years ago

3.5.0

3 years ago

3.4.4

3 years ago

3.4.5

3 years ago

3.4.3

3 years ago

3.4.2

3 years ago

3.4.1

3 years ago

3.4.0

3 years ago

3.3.0

3 years ago

3.2.1

3 years ago

3.2.0

3 years ago

3.1.1

3 years ago

3.1.0

3 years ago

3.0.11

4 years ago

3.0.10

4 years ago

3.0.9

4 years ago

3.0.8

4 years ago

3.0.7

4 years ago

3.0.6

4 years ago

3.0.5

4 years ago

3.0.4

4 years ago

3.0.3

4 years ago

3.0.2

4 years ago

3.0.1

4 years ago

3.0.0

4 years ago

2.4.2

4 years ago

2.4.1

4 years ago

2.4.0

4 years ago

2.3.2

4 years ago

2.3.1

4 years ago

2.3.0

4 years ago

2.2.17

4 years ago

2.2.15

4 years ago

2.2.16

4 years ago

2.2.14

4 years ago

2.2.13

4 years ago

2.2.12

4 years ago

2.2.11

5 years ago

2.2.10

5 years ago

2.2.9

5 years ago

2.2.8

5 years ago

2.2.7

5 years ago

2.2.6

5 years ago

2.2.5

5 years ago

2.2.4

5 years ago

2.2.3

5 years ago

2.2.2

5 years ago

2.2.1

5 years ago

2.2.0

5 years ago

2.1.12

5 years ago

2.1.11

5 years ago

2.1.10

5 years ago

2.1.9

5 years ago

2.1.8

5 years ago

2.1.7

5 years ago

2.1.6

5 years ago

2.1.5

5 years ago

2.1.4

5 years ago

2.1.3

5 years ago

2.1.2

5 years ago

2.1.1

5 years ago

2.1.0

5 years ago

2.0.11

5 years ago

2.0.10

5 years ago

2.0.9

5 years ago

2.0.8

5 years ago

2.0.7

5 years ago

2.0.6

5 years ago

2.0.5

5 years ago

2.0.4

5 years ago

2.0.3

5 years ago

2.0.2

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.2.1

5 years ago

1.2.0

5 years ago

1.1.27

5 years ago

1.1.26

5 years ago

1.1.25

5 years ago

1.1.24

5 years ago

1.1.23

5 years ago

1.1.22

5 years ago

1.1.21

5 years ago

1.1.20

5 years ago

1.1.19

5 years ago

1.1.18

6 years ago

1.1.17

6 years ago

1.1.16

6 years ago

1.1.15

6 years ago

1.1.14

6 years ago

1.1.13

6 years ago

1.1.12

6 years ago

1.1.11

6 years ago

1.1.10

6 years ago

1.1.9

6 years ago

1.1.8

6 years ago

1.1.7

6 years ago

1.1.6

6 years ago

1.1.5

6 years ago

1.1.4

6 years ago

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.15

6 years ago

1.0.14

6 years ago

1.0.13

6 years ago

1.0.12

6 years ago

1.0.11

7 years ago

1.0.10

7 years ago

1.0.9

7 years ago

1.0.8

7 years ago

1.0.7

7 years ago

1.0.6

7 years ago

1.0.5

7 years ago

1.0.4

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago

0.0.21

7 years ago

0.0.20

7 years ago

0.0.19

7 years ago

0.0.18

7 years ago

0.0.17

7 years ago

0.0.16

7 years ago

0.0.15

7 years ago

0.0.14

7 years ago

0.0.13

7 years ago

0.0.12

7 years ago

0.0.12-2

7 years ago

0.0.12-1

7 years ago

0.0.12-0

7 years ago

0.0.11-0

7 years ago

0.0.10-0

7 years ago

0.0.9-0

7 years ago

0.0.8-0

7 years ago

0.0.7-0

7 years ago

0.0.6-0

7 years ago

0.0.5-0

7 years ago

0.0.3-0

7 years ago

0.0.2-0

7 years ago

0.0.1-0

7 years ago

0.0.0-alpha.0

7 years ago