{"_id":"@cirrusct/mr-typedoc-plugin-markdown-docusaurus","_rev":"1-1553ea6f5da7ac3cc145cdcaa59eef55","name":"@cirrusct/mr-typedoc-plugin-markdown-docusaurus","dist-tags":{"latest":"2.2.23"},"versions":{"2.2.23":{"name":"@cirrusct/mr-typedoc-plugin-markdown-docusaurus","version":"2.2.23","description":"A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.","main":"dist/index.js","scripts":{"lint":"tslint --project ./tsconfig.json","build:ORIGINAL":"rm -rf dist && tsc && copyfiles --up 1 ./src/**/*.hbs ./dist/","prepublishOnly:DONT":"npm run test","pretest:DONT":"npm run lint && npm run build","test:DONT":"jest","test:updateSnapshot":"jest --updateSnapshot","fixtures":"rm -rf ./test/fixtures && node ./tasks/fixtures.js","examples":"npm run build && rm -rf out && node ./tasks/link-plugin.js && npm run examples:html && npm run examples:md","examples:html":"typedoc --tsconfig ./test/stubs/tsconfig.json --options ./test/options.json --plugin none --out ./out/html","examples:md":"typedoc --tsconfig ./test/stubs/tsconfig.json --options ./test/options.json --out ./out/md"},"author":{"name":"Thomas Grey"},"license":"MIT","engines":{"node":">= 8.0.0"},"bugs":{"url":"https://github.com/tom-grey/typedoc-plugin-markdown/issues"},"repository":{"type":"git","url":"git+https://github.com/tom-grey/typedoc-plugin-markdown.git"},"keywords":["markdown","typescript","documentation","api","typedocplugin","typedoc"],"peerDependencies":{"typedoc":">=0.16.0"},"devDependencies":{"@cirrusct/mr-cli-local":"^1.0.0","@types/fs-extra":"^8.1.0","@types/jest":"^25.1.3","@types/node":"^13.7.5","copyfiles":"^2.2.0","jest":"^25.1.0","ts-jest":"^25.2.1","tslint":"^6.0.0","typedoc":"0.16.10","typescript":"3.7.x"},"dependencies":{"@cirrusct/mr-core":"^1.1.25","fs-extra":"^8.1.0","handlebars":"^4.7.3"},"mr":{"build":{"copyFiles":[{"from":"src/**/*.hbs","globOptions":{"dot":true,"onlyFiles":false}}]}},"licenseText":"MIT License\n\nCopyright (c) 2016 Thomas Grey\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_id":"@cirrusct/mr-typedoc-plugin-markdown-docusaurus@2.2.23","dist":{"shasum":"a5a3bcdb63acaa1591b641d3256b1cb7dbbd09b8","integrity":"sha512-MWdaqymbHqzJXHgbll6XdTAq37rzVaeH7zIdUr8xWlqLhEdBtf20Huo4bcnF5mUslRk+jKuPVd3+9hGt+Wbygw==","tarball":"https://registry.npmjs.org/@cirrusct/mr-typedoc-plugin-markdown-docusaurus/-/mr-typedoc-plugin-markdown-docusaurus-2.2.23.tgz","fileCount":171,"unpackedSize":565759,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeeC6FCRA9TVsSAnZWagAAlhEP/jmgWtkGqj2rsrfbEOE3\nxMgxm4XbKlmY96MN+ldhqQZqqWIwik8YIiIj+WhG1k78NOEoP/kHwHC3w4Po\nKtMssy4zV/z9BL7zL7HRai6VK/uKpxMTMmViEimf0u+1TWmqZ8vH1nS9/3Tx\n9otMAytbIREmWoTy6B3TnN5xoSPBYtdKLm0PNNee1bkqmzQCO4Qawplgk5Eh\nWx3Xynm2UO2MDd0jzgKBDAgMi6/thNvWL5PtB40wpnkn8DFHt8l34U3u0TMr\ncQZZhGQw3CAXEmY9QVnX+IQXVJRqOkFcFV/4BeOjRNpK0tVa+TUYHzd+/IFG\njCwBp9hXNp1AOj/93yY6ExQev9etyfhwiXguboL85DSIQraMMKk5V0FOKW5q\noAiIFzuQG263vmNUFSxwWr9tJYYTz1dGL8i4VEZfjEXKN8d/pZVUExrOswDT\nyy20HQ6NKNCRImTZBtRpswdOdLCOiXAQ7mrjOdVgdqfmQhNVs4G2DYhBB0fD\n+FQHmy1+Dkmorjn9vqceNP4yBgimwUMG+w4MkJw9Gr3FQ4WgJn4Dli7ethFp\nxM+Qiss468CK1ZgJkar4uPOHDyIMn0Mlpjx22w6dRnV6P3qWSn3BLj/Zu/Zj\nGkEbnMPed64LHaUoE9CYNJ/D3jUAwIy94CAUBZFjzvHRQ0NcDxkKWDPnzYzd\nVifa\r\n=raAl\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDVUNlY+mhexSIossq92+o6KazKWwF40v3ON0bNHttJLgIhAK/aOSSVzX5SA96EwLmB0CJvhrpWl5Ck5E3OxO2V7l3F"}]},"maintainers":[{"name":"cirrusct","email":"npm@cirrusct.com"}],"_npmUser":{"name":"cirrusct","email":"npm@cirrusct.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mr-typedoc-plugin-markdown-docusaurus_2.2.23_1584934532652_0.9478423555106068"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-23T03:35:32.401Z","2.2.23":"2020-03-23T03:35:32.802Z","modified":"2022-04-04T23:02:39.782Z"},"maintainers":[{"name":"cirrusct","email":"npm@cirrusct.com"}],"description":"A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.","keywords":["markdown","typescript","documentation","api","typedocplugin","typedoc"],"repository":{"type":"git","url":"git+https://github.com/tom-grey/typedoc-plugin-markdown.git"},"author":{"name":"Thomas Grey"},"bugs":{"url":"https://github.com/tom-grey/typedoc-plugin-markdown/issues"},"license":"MIT","readme":"# typedoc-plugin-markdown\n\nA plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that enables TypeScript API documentation to be generated in Markdown.\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://travis-ci.org/tom-grey/typedoc-plugin-markdown.svg?branch=master)](https://travis-ci.org/tom-grey/typedoc-plugin-markdown)\n\n## What it does?\n\nThe plugin will replace the default HTML theme with a built-in Markdown theme, and expose some additional arguments.\n\nBy default, the Markdown theme will attempt to render standard CommonMark, suitable for the majority of Markdown engines.\nIt follows the same structure and file patterns as the default HTML theme.\n\n## Installation\n\n```bash\nnpm install --save-dev typedoc typedoc-plugin-markdown\n```\n\n## Usage\n\n```bash\n$ npx typedoc --plugin typedoc-plugin-markdown [args]\n```\n\n### Note:\n\n- The `--plugin` arg is optional - if omitted all installed plugins will run.\n- If using with the default HTML theme or other themes, use `--plugin none` to switch the plugin off.\n- The plugin needs to be executed from the same location as `typedoc`. Either run as an npm script or make sure to run `npx typedoc`.\n\n## Arguments\n\nThe following arguments can be used in addition to the default [TypeDoc arguments](https://github.com/TypeStrong/typedoc#arguments).\n\n- `--theme <markdown|docusaurus|docusaurus2|vuepress|bitbucket|path/to/theme>`<br />\n  Specify the theme that should be used. Defaults to `markdown`. Please read [Markdown Themes](https://github.com/tom-grey/typedoc-plugin-markdown/blob/master/THEMES.md) for further details.\n- `--namedAnchors`<br />\n  Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids.\n- `--hideSources`<br />\n  Do not print source file link rendering.\n- `--hideBreadcrumbs`<br />\n  Do not print breadcrumbs.\n- `--skipSidebar`<br />\n  Do not update the `sidebar.json` file when used with `docusaurus` theme.\n\n## License\n\n[MIT](https://github.com/tom-grey/typedoc-plugin-markdown/blob/master/LICENSE)\n","readmeFilename":"README.md"}