{"_id":"@anatoly-tenenev/typedoc-plugin-markdown","_rev":"2-eb197bc3c49596e22bde8eaa2c935b95","name":"@anatoly-tenenev/typedoc-plugin-markdown","dist-tags":{"latest":"3.16.2"},"versions":{"3.16.0":{"name":"@anatoly-tenenev/typedoc-plugin-markdown","version":"3.16.0","description":"A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.","main":"dist/index.js","scripts":{"lint":"eslint ./src --ext .ts","markdownlint":"yarn run docs:md && markdownlint ./docs/md","prepublishOnly":"yarn run lint && yarn run build","build":"rm -rf dist && tsc && copyfiles --up 1 ./src/**/*.hbs ./dist/","test":"jest","build-and-test":"yarn run build && yarn run test","docs":"yarn run build && yarn run docs:md && yarn run docs:html","docs:md":"typedoc --plugin typedoc-plugin-markdown --options ../../stub-project/typedoc-options.json --plugin typedoc-plugin-mdn-links --out ./docs/md","docs:html":"typedoc --options ../../stub-project/typedoc-options.json --out ./docs/html"},"author":{"name":"Thomas Grey"},"license":"MIT","bugs":{"url":"https://github.com/tgreyuk/typedoc-plugin-markdown/issues"},"repository":{"type":"git","url":"git+https://github.com/tgreyuk/typedoc-plugin-markdown.git","directory":"packages/typedoc-plugin-markdown"},"homepage":"https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown","keywords":["markdown","typescript","documentation","api","typedocplugin","typedoc"],"peerDependencies":{"typedoc":">=0.24.0"},"dependencies":{"handlebars":"^4.7.7"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"gitHead":"77722ee7463fd3b66460235e477783da5cb9bd35","types":"./dist/index.d.ts","_id":"@anatoly-tenenev/typedoc-plugin-markdown@3.16.0","_nodeVersion":"18.15.0","_npmVersion":"lerna/6.6.2/node@v18.15.0+x64 (darwin)","dist":{"integrity":"sha512-Ez2dqao/vbNKwEVMWXMFmlnLdRVry1b9iprR16nJKh2Bx5y6ltGXYrpzNYN9hRGGRueqyvFKoSFNutjAaqt92A==","shasum":"e98d9cd3c05dcd227bc249aa4fba92c69e3099bd","tarball":"https://registry.npmjs.org/@anatoly-tenenev/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.16.0.tgz","fileCount":85,"unpackedSize":115236,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD017i97ONYJ3psu5DVb84rE1W52DrXAyVgt92yKhI0wAIgQ/f28a57U7gUcnUioSj92BMC2bnKSWLdvX6WjK+E/IU="}]},"_npmUser":{"name":"anatoly-tenenev","email":"anatoly87ts@yandex.ru"},"directories":{},"maintainers":[{"name":"anatoly-tenenev","email":"anatoly87ts@yandex.ru"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-markdown_3.16.0_1698763254092_0.5082526757859143"},"_hasShrinkwrap":false},"3.16.1":{"name":"@anatoly-tenenev/typedoc-plugin-markdown","version":"3.16.1","description":"A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.","main":"dist/index.js","scripts":{"lint":"eslint ./src --ext .ts","markdownlint":"yarn run docs:md && markdownlint ./docs/md","prepublishOnly":"yarn run lint && yarn run build","build":"rm -rf dist && tsc && copyfiles --up 1 ./src/**/*.hbs ./dist/","test":"jest","build-and-test":"yarn run build && yarn run test","docs":"yarn run build && yarn run docs:md && yarn run docs:html","docs:md":"typedoc --plugin typedoc-plugin-markdown --options ../../stub-project/typedoc-options.json --plugin typedoc-plugin-mdn-links --out ./docs/md","docs:html":"typedoc --options ../../stub-project/typedoc-options.json --out ./docs/html"},"author":{"name":"Thomas Grey"},"license":"MIT","bugs":{"url":"https://github.com/tgreyuk/typedoc-plugin-markdown/issues"},"repository":{"type":"git","url":"git+https://github.com/tgreyuk/typedoc-plugin-markdown.git","directory":"packages/typedoc-plugin-markdown"},"homepage":"https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown","keywords":["markdown","typescript","documentation","api","typedocplugin","typedoc"],"peerDependencies":{"typedoc":">=0.24.0"},"dependencies":{"handlebars":"^4.7.7"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"gitHead":"84b0541331af171c91bdc91c5dbf91a445f6c25f","types":"./dist/index.d.ts","_id":"@anatoly-tenenev/typedoc-plugin-markdown@3.16.1","_nodeVersion":"18.15.0","_npmVersion":"lerna/6.6.2/node@v18.15.0+x64 (darwin)","dist":{"integrity":"sha512-oCPuinyo7hMiwsWoMCWpCY78g6Am3viDBxJ/hZY4f7hjgoXwoj5RE+4kvMx4OkmQFzkabkUORpBIQSTSarT0cg==","shasum":"443cb25caf3983b54ebd2c5a65607dc69feca216","tarball":"https://registry.npmjs.org/@anatoly-tenenev/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.16.1.tgz","fileCount":85,"unpackedSize":115030,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGVA4SxZcxZQfwwSGlq863JVg8FAD6NvlR8py94fo2adAiB2+Ak1oSdi6HaClPytc0tvC7sj/7J6BhVCkLjuZ5BS5g=="}]},"_npmUser":{"name":"anatoly-tenenev","email":"anatoly87ts@yandex.ru"},"directories":{},"maintainers":[{"name":"anatoly-tenenev","email":"anatoly87ts@yandex.ru"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-markdown_3.16.1_1698829102736_0.9655676852071857"},"_hasShrinkwrap":false},"3.16.2":{"name":"@anatoly-tenenev/typedoc-plugin-markdown","version":"3.16.2","description":"A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.","main":"dist/index.js","scripts":{"lint":"eslint ./src --ext .ts","markdownlint":"yarn run docs:md && markdownlint ./docs/md","prepublishOnly":"yarn run lint && yarn run build","build":"rm -rf dist && tsc && copyfiles --up 1 ./src/**/*.hbs ./dist/","test":"jest","build-and-test":"yarn run build && yarn run test","docs":"yarn run build && yarn run docs:md && yarn run docs:html","docs:md":"typedoc --plugin typedoc-plugin-markdown --options ../../stub-project/typedoc-options.json --plugin typedoc-plugin-mdn-links --out ./docs/md","docs:html":"typedoc --options ../../stub-project/typedoc-options.json --out ./docs/html"},"author":{"name":"Thomas Grey"},"license":"MIT","bugs":{"url":"https://github.com/tgreyuk/typedoc-plugin-markdown/issues"},"repository":{"type":"git","url":"git+https://github.com/tgreyuk/typedoc-plugin-markdown.git","directory":"packages/typedoc-plugin-markdown"},"homepage":"https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown","keywords":["markdown","typescript","documentation","api","typedocplugin","typedoc"],"peerDependencies":{"typedoc":">=0.24.0"},"dependencies":{"handlebars":"^4.7.7"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"gitHead":"09cd005164483e71e3b31f3d496fd901b222359f","types":"./dist/index.d.ts","_id":"@anatoly-tenenev/typedoc-plugin-markdown@3.16.2","_nodeVersion":"18.15.0","_npmVersion":"lerna/6.6.2/node@v18.15.0+x64 (darwin)","dist":{"integrity":"sha512-LLacnWzbetPsirk/re1IBZzslnp5cct/adtvR11qGF+EOUC6PRpA+Vrv1AOpx8dxU2HenefZ1wMbq7OubJ8E5g==","shasum":"e5a3a72999ca92657e4321049c51819e10d998f7","tarball":"https://registry.npmjs.org/@anatoly-tenenev/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.16.2.tgz","fileCount":85,"unpackedSize":115030,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFD5nQ9+qvivhvwLZDJk6zla086ji2PRsh2P5Ixm4474AiB/awiZ+rdq1Cnfpy9106rCAFzjf7o0TCiYBNZayLjdMw=="}]},"_npmUser":{"name":"anatoly-tenenev","email":"anatoly87ts@yandex.ru"},"directories":{},"maintainers":[{"name":"anatoly-tenenev","email":"anatoly87ts@yandex.ru"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-markdown_3.16.2_1698829370173_0.17873474038568338"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-31T14:40:53.999Z","3.16.0":"2023-10-31T14:40:54.396Z","modified":"2023-11-01T09:02:50.528Z","3.16.1":"2023-11-01T08:58:22.899Z","3.16.2":"2023-11-01T09:02:50.365Z"},"maintainers":[{"name":"anatoly-tenenev","email":"anatoly87ts@yandex.ru"}],"description":"A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.","homepage":"https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown","keywords":["markdown","typescript","documentation","api","typedocplugin","typedoc"],"repository":{"type":"git","url":"git+https://github.com/tgreyuk/typedoc-plugin-markdown.git","directory":"packages/typedoc-plugin-markdown"},"author":{"name":"Thomas Grey"},"bugs":{"url":"https://github.com/tgreyuk/typedoc-plugin-markdown/issues"},"license":"MIT","readme":"# typedoc-plugin-markdown\n\nA plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that renders TypeScript API documentation as Markdown files. (By default, TypeDoc will render API documentation as a webpage, e.g. HTML files.)\n\n[![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg)](https://www.npmjs.com/package/typedoc-plugin-markdown)\n[![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)\n\n## What does it do?\n\nThe plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options.\n\nUseful if documentation is required to be included in project README files, Wikis and static site generators.\n\n## Installation\n\n```bash\nnpm install --save-dev typedoc typedoc-plugin-markdown\n```\n\n## Usage\n\nUsage is the same as documented at [TypeDoc](https://typedoc.org/guides/installation/#command-line-interface).\n\n```bash\ntypedoc --plugin typedoc-plugin-markdown --out docs src/index.ts\n```\n\n## Options\n\nThis plugin provides additional options beyond the normal options that are [provided by TypeDoc](https://typedoc.org/guides/options/), which are listed below. Note that any vanilla TypeDoc options that customize the HTML theme will be ignored.\n\n- `--entryDocument`
\n The file name of the entry document. Defaults to `README.md`.\n- `--hideBreadcrumbs`
\n Do not render breadcrumbs in template header. Defaults to `false`.\n- `--hideInPageTOC`
\n Do not render in-page table of contents items. Defaults to `false`.\n- `--publicPath`
\n Specify the base path for all urls. If undefined urls will be relative. Defaults to `.`.\n- `--namedAnchors`
\n Use HTML named anchors tags for implementations that do not assign header ids. Defaults to `false`.\n- `--preserveAnchorCasing`
\n Preserve anchor id casing for implementations where original case is desirable. Defaults to `false`.\n\n## License\n\n[MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/LICENSE)\n","readmeFilename":"README.md"}