{siteConfig.tagline}
12 |{name}
8 |
9 | );
10 | };
11 |
--------------------------------------------------------------------------------
/docs/components/package-version.jsx:
--------------------------------------------------------------------------------
1 | import { packageVersions } from '../utils/package-versions';
2 |
3 | export function PackageVersion({ name }) {
4 | const version = packageVersions[name];
5 |
6 | return (
7 |
8 | Version: {version}
9 |
10 | );
11 | }
12 |
--------------------------------------------------------------------------------
/docs/content/docs/_meta.js:
--------------------------------------------------------------------------------
1 | export default {
2 | index: 'Introduction',
3 | '-- Getting Started': {
4 | type: 'separator',
5 | title: 'Getting Started',
6 | },
7 | 'quick-start': '',
8 | 'typedoc-options': '',
9 | options: '',
10 | '-- Guides': {
11 | type: 'separator',
12 | title: 'Guides',
13 | },
14 | 'output-file-structure': '',
15 | 'customizing-output': '',
16 | 'utilizing-navigation': '',
17 | 'option-typings': '',
18 | '-- Support': {
19 | type: 'separator',
20 | title: 'Support',
21 | },
22 | troubleshooting: '',
23 | versioning: '',
24 | CHANGELOG: 'Changelog',
25 | 'migration-guide': 'Migration Guide (v4)',
26 | };
27 |
--------------------------------------------------------------------------------
/docs/content/docs/options/_meta.js:
--------------------------------------------------------------------------------
1 | export default {
2 | 'file-options': '',
3 | 'display-options': '',
4 | 'utility-options': '',
5 | };
6 |
--------------------------------------------------------------------------------
/docs/content/docs/quick-start.mdx:
--------------------------------------------------------------------------------
1 | # Quick Start
2 |
3 | ## Installation
4 |
5 | ```sh npm2yarn
6 | npm install typedoc typedoc-plugin-markdown --save-dev
7 | ```
8 |
9 | ## Usage
10 |
11 | Plugins are loaded by using the TypeDoc `plugin` configuration option:
12 |
13 | ```shell filename="CLI"
14 | typedoc --plugin typedoc-plugin-markdown --out ./docs
15 | ```
16 |
17 | Or:
18 |
19 | ```json filename="typedoc.json"
20 | {
21 | "plugin": ["typedoc-plugin-markdown"],
22 | "out": "./docs"
23 | }
24 | ```
25 |
26 | ```json filename="package.json"
27 | {
28 | "docs": "typedoc"
29 | }
30 | ```
31 |
32 | ```bash filename="CLI"
33 | npm run docs
34 | ```
35 |
--------------------------------------------------------------------------------
/docs/content/plugins/_meta.js:
--------------------------------------------------------------------------------
1 | export default {
2 | index: 'Utils & Themes Index',
3 | '-- Utils': {
4 | type: 'separator',
5 | title: 'Utils',
6 | },
7 | frontmatter: 'Frontmatter',
8 | remark: 'Remark',
9 | '-- Themes': {
10 | type: 'separator',
11 | title: 'Themes',
12 | },
13 | 'github-wiki': 'Github Wiki',
14 | 'gitlab-wiki': 'Gitlab Wiki',
15 | vitepress: 'VitePress',
16 | docusaurus: 'Docusaurus',
17 | };
18 |
--------------------------------------------------------------------------------
/docs/content/plugins/docusaurus/_meta.js:
--------------------------------------------------------------------------------
1 | export default {
2 | 'quick-start': '',
3 | options: '',
4 | guides: '',
5 | 'migration-guide': '',
6 | };
7 |
--------------------------------------------------------------------------------
/docs/content/plugins/docusaurus/guides/_meta.js:
--------------------------------------------------------------------------------
1 | export default {
2 | sidebar: '',
3 | 'multi-instance': '',
4 | 'watch-mode': '',
5 | mdx: '',
6 | };
7 |
--------------------------------------------------------------------------------
/docs/content/plugins/docusaurus/guides/mdx.mdx:
--------------------------------------------------------------------------------
1 | # MDX vs. CommonMark
2 |
3 | By default, Docusaurus treats Markdown files as MDX.
4 |
5 | This means that non-conformant MDX syntax in your documentation comments will cause a compilation error.
6 |
7 | If you don't need MDX features, you can opt into CommonMark, which allows for more relaxed Markdown parsing.
8 |
9 | ```js filename="docusaurus.config.js"
10 | markdown: {
11 | format: 'detect',
12 | }
13 | ```
14 |
15 | See https://docusaurus.io/docs/markdown-features#mdx-vs-commonmark for more information.
16 |
--------------------------------------------------------------------------------
/docs/content/plugins/docusaurus/guides/multi-instance.mdx:
--------------------------------------------------------------------------------
1 | import { Callout } from 'nextra/components';
2 |
3 | # Multi Instance
4 |
5 | It is possible to build multi TypeDoc instances by passing in multiple configs with unique ids:
6 |
7 | ```js filename="docusaurus.config.js"
8 | module.exports = {
9 | plugins: [
10 | [
11 | 'docusaurus-plugin-typedoc',
12 | {
13 | id: 'api-1',
14 | entryPoints: ['../api-1/src/index.ts'],
15 | tsconfig: '../api-1/tsconfig.json',
16 | out: 'api-1',
17 | },
18 | ],
19 | [
20 | 'docusaurus-plugin-typedoc',
21 | {
22 | id: 'api-2',
23 | entryPoints: ['../api-2/src/index.ts'],
24 | tsconfig: '../api-2/tsconfig.json',
25 | out: 'api-2',
26 | },
27 | ],
28 | ],
29 | };
30 | ```
31 |
--------------------------------------------------------------------------------
/docs/content/plugins/docusaurus/guides/watch-mode.mdx:
--------------------------------------------------------------------------------
1 | import { Callout } from 'nextra/components';
2 |
3 | # Watch Mode
4 |
5 | Watching files is supported by passing in the `watch: true` option see https://typedoc.org/guides/options/#watch.
6 |
7 | Targetting the option in development mode only can be achieved using Node.js Environment Variables:
8 |
9 | ```json filename="package.json"
10 | {
11 | "scripts": {
12 | "start": "TYPEDOC_WATCH=true docusaurus start",
13 | "build": "TYPEDOC_WATCH=false docusaurus build"
14 | }
15 | }
16 | ```
17 |
18 | ```js filename="docusaurus.config.js"
19 | module.exports = {
20 | plugins: [
21 | [
22 | 'docusaurus-plugin-typedoc',
23 | {
24 | entryPoints: ['../src/index.ts'],
25 | tsconfig: '../tsconfig.json',
26 | watch: process.env.TYPEDOC_WATCH,
27 | },
28 | ],
29 | ],
30 | };
31 | ```
32 |
--------------------------------------------------------------------------------
/docs/content/plugins/frontmatter/_meta.js:
--------------------------------------------------------------------------------
1 | export default {
2 | 'quick-start': '',
3 | options: '',
4 | customizing: '',
5 | ['block-tags-warning']: 'Block Tags Warning',
6 | };
7 |
--------------------------------------------------------------------------------
/docs/content/plugins/frontmatter/quick-start.mdx:
--------------------------------------------------------------------------------
1 | # Quick Start
2 |
3 | ## Installation
4 |
5 | ```sh npm2yarn
6 | npm install typedoc-plugin-frontmatter --save-dev
7 | ```
8 |
9 | ## Usage
10 |
11 | ```json filename="typedoc.json"
12 | {
13 | "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-frontmatter"]
14 | }
15 | ```
16 |
17 | ```bash filename="CLI"
18 | npm run typedoc
19 | ```
20 |
--------------------------------------------------------------------------------
/docs/content/plugins/github-wiki/_meta.js:
--------------------------------------------------------------------------------
1 | export default {
2 | 'quick-start': '',
3 | options: '',
4 | };
5 |
--------------------------------------------------------------------------------
/docs/content/plugins/github-wiki/quick-start.mdx:
--------------------------------------------------------------------------------
1 | # Quick Start
2 |
3 | ## Installation
4 |
5 | ```sh npm2yarn
6 | npm install typedoc typedoc-plugin-markdown typedoc-github-wiki-theme --save-dev
7 | ```
8 |
9 | ## Usage
10 |
11 | ```json filename="typedoc.json"
12 | {
13 | "plugin": ["typedoc-plugin-markdown", "typedoc-github-wiki-theme"]
14 | }
15 | ```
16 |
17 | ```bash filename="CLI"
18 | npm run typedoc
19 | ```
20 |
--------------------------------------------------------------------------------
/docs/content/plugins/gitlab-wiki/_meta.js:
--------------------------------------------------------------------------------
1 | export default {
2 | 'quick-start': '',
3 | options: '',
4 | };
5 |
--------------------------------------------------------------------------------
/docs/content/plugins/gitlab-wiki/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | asIndexPage: true
3 | ---
4 |
5 | # typedoc-gitlab-wiki-theme
6 |
7 | ${header} | `, 12 | ) 13 | .join('')} 14 |
---|
25 | 26 | ${cell === '-' ? '‐' : cell} 27 | 28 | | `, 29 | ) 30 | .join('')} 31 |