{"_id":"@carlosingles/typedoc-gitlab-wiki-theme","name":"@carlosingles/typedoc-gitlab-wiki-theme","dist-tags":{"latest":"1.1.1"},"versions":{"1.1.1":{"name":"@carlosingles/typedoc-gitlab-wiki-theme","version":"1.1.1","description":"An extension of the default theme from typedoc-plugin-markdown to create a compatible file structure for GitLab Wiki pages.","main":"dist/index.js","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-gitlab-wiki-theme"},"homepage":"https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-gitlab-wiki-theme","scripts":{"lint":"eslint ./src --ext .ts","prepublishOnly":"yarn run lint && yarn run build","build":"rm -rf ./dist && tsc","demo":"rm -rf ./demo && yarn run build && typedoc --plugin typedoc-plugin-markdown --plugin typedoc-gitlab-wiki-theme --options ../../stub-project/typedoc-options.json --out ./demo"},"author":{"name":"Thomas Grey"},"license":"MIT","peerDependencies":{"typedoc":">=0.24.0","typedoc-plugin-markdown":">=3.15.0"},"devDependencies":{"typedoc-plugin-markdown":"^3.15.0"},"keywords":["typedoc","typedoc-theme","gitlab","wiki","markdown"],"gitHead":"c976d830d204bd191f9bf7a945439cfb908417f1","_id":"@carlosingles/typedoc-gitlab-wiki-theme@1.1.1","types":"./dist/index.d.ts","_nodeVersion":"18.16.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-wDGAK+54AIL+ucJdMW1KncRx3TKNfXyZAIlXmKI0pZP33YfBUtvFNCyNQAHwvvhr+06i/A1t6oJTgMrZTuzqpA==","shasum":"32103015ac4c838e8b01d3a7bacc7d630434ed2f","tarball":"https://registry.npmjs.org/@carlosingles/typedoc-gitlab-wiki-theme/-/typedoc-gitlab-wiki-theme-1.1.1.tgz","fileCount":9,"unpackedSize":8384,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDMwl+qViN7H4NdiatL5IbV7Zyw+DwI/H3tZZ6hcLD4oAIgYMv+NuUBN1DIQEJC1XtpQaiuTxcUifP1Ki6Z7KCDR0M="}]},"_npmUser":{"name":"carlosingles","email":"hello@carlosingles.com"},"directories":{},"maintainers":[{"name":"carlosingles","email":"hello@carlosingles.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-gitlab-wiki-theme_1.1.1_1693885745063_0.6457727874881398"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-05T03:49:04.911Z","1.1.1":"2023-09-05T03:49:05.263Z","modified":"2023-09-05T03:49:05.540Z"},"maintainers":[{"name":"carlosingles","email":"hello@carlosingles.com"}],"description":"An extension of the default theme from typedoc-plugin-markdown to create a compatible file structure for GitLab Wiki pages.","homepage":"https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-gitlab-wiki-theme","keywords":["typedoc","typedoc-theme","gitlab","wiki","markdown"],"repository":{"type":"git","url":"git+https://github.com/tgreyuk/typedoc-plugin-markdown.git","directory":"packages/typedoc-gitlab-wiki-theme"},"author":{"name":"Thomas Grey"},"bugs":{"url":"https://github.com/tgreyuk/typedoc-plugin-markdown/issues"},"license":"MIT","readme":"# typedoc-gitlab-wiki-theme\n\nA [Gitlab Wiki](https://docs.gitlab.com/ee/user/project/wiki/) compatible [TypeDoc](https://github.com/TypeStrong/typedoc) theme.\n\n[![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme)\n![CI](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)\n\n## What Does It Do?\n\n- Generates Wiki friendly file names.\n- Updates internal urls to a compatible format.\n- Writes a `_sidebar.md` file to enable custom sidebar navigation.\n\n## Installation\n\n```shell\nnpm install typedoc typedoc-plugin-markdown typedoc-gitlab-wiki-theme --save-dev\n```\n\n## Usage\n\n```bash\n$ npx typedoc --plugin typedoc-plugin-markdown --plugin typedoc-gitlab-wiki-theme [args]\n```\n\n## Options\n\nPlease refer to [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-plugin-markdown/README.md#options).\n\n## License\n\n[MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-gitlab-wiki-theme/LICENSE)\n","readmeFilename":"README.md"}