From 6040f3217fbdbe4bab0c102fc3ca606930dcbc79 Mon Sep 17 00:00:00 2001 From: terwer Date: Tue, 16 May 2023 13:38:05 +0800 Subject: [PATCH] chore: fix ci --- apps/zhi-docs-vitepress/.gitignore | 5 - .../docs/.vitepress/config.ts | 33 - .../docs/.vitepress/theme/index.ts | 16 - .../docs/.vitepress/theme/style.css | 91 - apps/zhi-docs-vitepress/docs/api-examples.md | 49 - apps/zhi-docs-vitepress/docs/api-nav.json | 56 - apps/zhi-docs-vitepress/docs/blog/index.md | 3 - .../docs/blog/zhi-0-1-0-is-on-the-way.md | 12 - apps/zhi-docs-vitepress/docs/index.md | 25 - .../docs/markdown-examples.md | 85 - apps/zhi-docs-vitepress/package-lock.json | 1890 ----------------- apps/zhi-docs-vitepress/package.json | 22 - apps/zhi-docs-vitepress/tsconfig.json | 38 - apps/zhi-docs-vitepress/typedoc.json | 18 - tools/api-docs/api-extractor-base.json | 435 ---- tools/api-docs/api-extractor.example.json | 8 - tools/api-docs/package.json | 12 - tools/api-docs/tsdoc.base.json | 46 - .../.markdownlint.yaml | 18 - tools/typedoc-plugin-markdown/CHANGELOG.md | 373 ---- tools/typedoc-plugin-markdown/LICENSE | 21 - tools/typedoc-plugin-markdown/README.md | 104 - .../docs/file-output-options.md | 115 - tools/typedoc-plugin-markdown/jest.config.js | 6 - tools/typedoc-plugin-markdown/package.json | 47 - .../scripts/build-resources.ts | 150 -- .../src/converter/models.ts | 7 - .../src/converter/navigation-builder.ts | 77 - .../src/converter/url-builder.ts | 429 ---- tools/typedoc-plugin-markdown/src/index.ts | 35 - tools/typedoc-plugin-markdown/src/models.ts | 79 - .../src/options/options-reader.ts | 35 - .../src/options/options.ts | 190 -- .../src/renderer/renderer.ts | 108 - .../src/resources/partials/breadcrumbs.ts | 46 - .../src/resources/partials/comment.parts.ts | 45 - .../src/resources/partials/comment.ts | 34 - .../src/resources/partials/hierarchy.ts | 48 - .../partials/member.declaration.identifier.ts | 64 - .../partials/member.declaration.name.ts | 39 - .../resources/partials/member.declaration.ts | 89 - .../partials/member.indexsignature.title.ts | 25 - .../resources/partials/member.inheritance.ts | 84 - .../src/resources/partials/member.kind-tag.ts | 14 - .../resources/partials/member.reference.ts | 21 - .../resources/partials/member.reflection.ts | 72 - .../partials/member.signature.identifier.ts | 66 - .../resources/partials/member.signature.ts | 73 - .../src/resources/partials/member.sources.ts | 22 - .../src/resources/partials/member.title.ts | 22 - .../src/resources/partials/member.ts | 55 - .../partials/member.type-declaration.ts | 32 - .../src/resources/partials/members.ts | 96 - .../src/resources/partials/navigation.ts | 19 - .../src/resources/partials/page.header.ts | 97 - .../src/resources/partials/page.title.ts | 24 - .../resources/partials/table.enum-members.ts | 65 - .../resources/partials/table.parameters.ts | 106 - .../resources/partials/table.properties.ts | 98 - .../partials/table.typeparameters.ts | 65 - .../src/resources/partials/toc.ts | 107 - .../src/resources/partials/type.array.ts | 12 - .../resources/partials/type.conditional.ts | 26 - .../resources/partials/type.declaration.ts | 44 - .../src/resources/partials/type.function.ts | 25 - .../resources/partials/type.index-access.ts | 16 - .../src/resources/partials/type.inferred.ts | 10 - .../resources/partials/type.intersection.ts | 13 - .../src/resources/partials/type.intrinsic.ts | 10 - .../src/resources/partials/type.literal.ts | 12 - .../src/resources/partials/type.query.ts | 12 - .../src/resources/partials/type.reference.ts | 40 - .../src/resources/partials/type.reflection.ts | 23 - .../src/resources/partials/type.some.ts | 88 - .../src/resources/partials/type.tuple.ts | 11 - .../resources/partials/type.type-operator.ts | 10 - .../src/resources/partials/type.union.ts | 11 - .../src/resources/partials/type.unknown.ts | 10 - .../src/resources/resources.ts | 189 -- .../src/resources/templates/member.ts | 26 - .../src/resources/templates/project.ts | 47 - .../src/resources/templates/readme.ts | 19 - .../src/resources/templates/reflection.ts | 30 - .../src/support/constants.ts | 21 - .../src/support/els.ts | 43 - .../src/support/helpers.ts | 46 - .../src/support/utils.ts | 58 - .../src/theme-render-context.ts | 66 - tools/typedoc-plugin-markdown/src/theme.ts | 80 - .../__snapshots__/breadcrumbs.spec.ts.snap | 11 - .../__snapshots__/categories.spec.ts.snap | 507 ----- .../specs/__snapshots__/comments.spec.ts.snap | 52 - .../__snapshots__/declarations.spec.ts.snap | 379 ---- .../specs/__snapshots__/generics.spec.ts.snap | 87 - .../specs/__snapshots__/groups.spec.ts.snap | 273 --- .../__snapshots__/hierarchy.spec.ts.snap | 8 - .../__snapshots__/navigation.spec.ts.snap | 1758 --------------- .../__snapshots__/signatures.spec.ts.snap | 403 ---- .../specs/__snapshots__/types.spec.ts.snap | 37 - .../specs/__snapshots__/urls.spec.ts.snap | 282 --- .../test/specs/breadcrumbs.spec.ts | 79 - .../test/specs/categories.spec.ts | 79 - .../test/specs/comments.spec.ts | 48 - .../test/specs/declarations.spec.ts | 132 -- .../test/specs/generics.spec.ts | 68 - .../test/specs/groups.spec.ts | 57 - .../test/specs/hierarchy.spec.ts | 27 - .../test/specs/navigation.spec.ts | 119 -- .../test/specs/signatures.spec.ts | 193 -- .../test/specs/types.spec.ts | 161 -- .../test/specs/urls.spec.ts | 163 -- tools/typedoc-plugin-markdown/tsconfig.json | 7 - .../tsconfig.test.json | 3 - tools/typedoc-tsconfig/tsconfig.json | 16 - tools/typedoc-tsconfig/tsconfig.test.json | 7 - tools/typedoc-vitepress-theme/.gitignore | 1 - tools/typedoc-vitepress-theme/CHANGELOG.md | 12 - tools/typedoc-vitepress-theme/LICENSE | 21 - tools/typedoc-vitepress-theme/README.md | 165 -- tools/typedoc-vitepress-theme/jest.config.js | 7 - tools/typedoc-vitepress-theme/package.json | 37 - tools/typedoc-vitepress-theme/src/index.ts | 57 - tools/typedoc-vitepress-theme/src/model.ts | 4 - tools/typedoc-vitepress-theme/src/options.ts | 4 - .../src/sidebars/sidebar.vitepress.ts | 18 - .../src/sidebars/sidebar.vuepress1.ts | 24 - .../src/sidebars/sidebar.vuepress2.ts | 18 - .../src/sidebars/sidebars.ts | 19 - tools/typedoc-vitepress-theme/tsconfig.json | 8 - tools/typedoc-vitepress-theme/typedoc.json | 9 - tools/webpack-siyuan-plugin/package.json | 31 - 131 files changed, 12555 deletions(-) delete mode 100644 apps/zhi-docs-vitepress/.gitignore delete mode 100644 apps/zhi-docs-vitepress/docs/.vitepress/config.ts delete mode 100644 apps/zhi-docs-vitepress/docs/.vitepress/theme/index.ts delete mode 100644 apps/zhi-docs-vitepress/docs/.vitepress/theme/style.css delete mode 100644 apps/zhi-docs-vitepress/docs/api-examples.md delete mode 100644 apps/zhi-docs-vitepress/docs/api-nav.json delete mode 100644 apps/zhi-docs-vitepress/docs/blog/index.md delete mode 100644 apps/zhi-docs-vitepress/docs/blog/zhi-0-1-0-is-on-the-way.md delete mode 100644 apps/zhi-docs-vitepress/docs/index.md delete mode 100644 apps/zhi-docs-vitepress/docs/markdown-examples.md delete mode 100644 apps/zhi-docs-vitepress/package-lock.json delete mode 100644 apps/zhi-docs-vitepress/package.json delete mode 100644 apps/zhi-docs-vitepress/tsconfig.json delete mode 100644 apps/zhi-docs-vitepress/typedoc.json delete mode 100644 tools/api-docs/api-extractor-base.json delete mode 100644 tools/api-docs/api-extractor.example.json delete mode 100644 tools/api-docs/package.json delete mode 100644 tools/api-docs/tsdoc.base.json delete mode 100644 tools/typedoc-plugin-markdown/.markdownlint.yaml delete mode 100644 tools/typedoc-plugin-markdown/CHANGELOG.md delete mode 100644 tools/typedoc-plugin-markdown/LICENSE delete mode 100644 tools/typedoc-plugin-markdown/README.md delete mode 100644 tools/typedoc-plugin-markdown/docs/file-output-options.md delete mode 100644 tools/typedoc-plugin-markdown/jest.config.js delete mode 100644 tools/typedoc-plugin-markdown/package.json delete mode 100644 tools/typedoc-plugin-markdown/scripts/build-resources.ts delete mode 100644 tools/typedoc-plugin-markdown/src/converter/models.ts delete mode 100644 tools/typedoc-plugin-markdown/src/converter/navigation-builder.ts delete mode 100644 tools/typedoc-plugin-markdown/src/converter/url-builder.ts delete mode 100644 tools/typedoc-plugin-markdown/src/index.ts delete mode 100644 tools/typedoc-plugin-markdown/src/models.ts delete mode 100644 tools/typedoc-plugin-markdown/src/options/options-reader.ts delete mode 100644 tools/typedoc-plugin-markdown/src/options/options.ts delete mode 100644 tools/typedoc-plugin-markdown/src/renderer/renderer.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/breadcrumbs.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/comment.parts.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/comment.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/hierarchy.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.identifier.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.name.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.indexsignature.title.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.inheritance.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.kind-tag.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.reference.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.reflection.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.signature.identifier.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.signature.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.sources.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.title.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/member.type-declaration.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/members.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/navigation.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/page.header.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/page.title.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/table.enum-members.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/table.parameters.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/table.properties.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/table.typeparameters.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/toc.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.array.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.conditional.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.declaration.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.function.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.index-access.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.inferred.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.intersection.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.intrinsic.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.literal.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.query.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.reference.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.reflection.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.some.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.tuple.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.type-operator.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.union.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/partials/type.unknown.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/resources.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/templates/member.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/templates/project.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/templates/readme.ts delete mode 100644 tools/typedoc-plugin-markdown/src/resources/templates/reflection.ts delete mode 100644 tools/typedoc-plugin-markdown/src/support/constants.ts delete mode 100644 tools/typedoc-plugin-markdown/src/support/els.ts delete mode 100644 tools/typedoc-plugin-markdown/src/support/helpers.ts delete mode 100644 tools/typedoc-plugin-markdown/src/support/utils.ts delete mode 100644 tools/typedoc-plugin-markdown/src/theme-render-context.ts delete mode 100644 tools/typedoc-plugin-markdown/src/theme.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/breadcrumbs.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/categories.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/declarations.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/generics.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/hierarchy.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/signatures.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/types.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap delete mode 100644 tools/typedoc-plugin-markdown/test/specs/breadcrumbs.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/categories.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/comments.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/declarations.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/generics.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/groups.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/hierarchy.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/navigation.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/signatures.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/types.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/test/specs/urls.spec.ts delete mode 100644 tools/typedoc-plugin-markdown/tsconfig.json delete mode 100644 tools/typedoc-plugin-markdown/tsconfig.test.json delete mode 100644 tools/typedoc-tsconfig/tsconfig.json delete mode 100644 tools/typedoc-tsconfig/tsconfig.test.json delete mode 100644 tools/typedoc-vitepress-theme/.gitignore delete mode 100644 tools/typedoc-vitepress-theme/CHANGELOG.md delete mode 100644 tools/typedoc-vitepress-theme/LICENSE delete mode 100644 tools/typedoc-vitepress-theme/README.md delete mode 100644 tools/typedoc-vitepress-theme/jest.config.js delete mode 100644 tools/typedoc-vitepress-theme/package.json delete mode 100644 tools/typedoc-vitepress-theme/src/index.ts delete mode 100644 tools/typedoc-vitepress-theme/src/model.ts delete mode 100644 tools/typedoc-vitepress-theme/src/options.ts delete mode 100644 tools/typedoc-vitepress-theme/src/sidebars/sidebar.vitepress.ts delete mode 100644 tools/typedoc-vitepress-theme/src/sidebars/sidebar.vuepress1.ts delete mode 100644 tools/typedoc-vitepress-theme/src/sidebars/sidebar.vuepress2.ts delete mode 100644 tools/typedoc-vitepress-theme/src/sidebars/sidebars.ts delete mode 100644 tools/typedoc-vitepress-theme/tsconfig.json delete mode 100644 tools/typedoc-vitepress-theme/typedoc.json delete mode 100644 tools/webpack-siyuan-plugin/package.json diff --git a/apps/zhi-docs-vitepress/.gitignore b/apps/zhi-docs-vitepress/.gitignore deleted file mode 100644 index 330a9065..00000000 --- a/apps/zhi-docs-vitepress/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -api -node_modules -.temp -cache -docs/api diff --git a/apps/zhi-docs-vitepress/docs/.vitepress/config.ts b/apps/zhi-docs-vitepress/docs/.vitepress/config.ts deleted file mode 100644 index 974a0f28..00000000 --- a/apps/zhi-docs-vitepress/docs/.vitepress/config.ts +++ /dev/null @@ -1,33 +0,0 @@ -import { defineConfig } from "vitepress" -import typedocSidebar from "../api/typedoc-sidebar.json" - -// https://vitepress.dev/reference/site-config -export default defineConfig({ - title: "Zhi Framework", - description: "The ultimate framework for building blog and theme", - themeConfig: { - // https://vitepress.dev/reference/default-theme-config - nav: [ - { text: "Home", link: "/" }, - { text: "Examples", link: "/markdown-examples" }, - { text: "Blog", link: "/blog/" }, - { text: "API", link: "/api/" }, - ], - - sidebar: [ - { - text: "Examples", - items: [ - { text: "Markdown Examples", link: "/markdown-examples" }, - { text: "Runtime API Examples", link: "/api-examples" }, - ], - }, - { - text: "API", - items: typedocSidebar as any[], - }, - ], - - socialLinks: [{ icon: "github", link: "https://github.com/terwer/zhi" }], - }, -}) diff --git a/apps/zhi-docs-vitepress/docs/.vitepress/theme/index.ts b/apps/zhi-docs-vitepress/docs/.vitepress/theme/index.ts deleted file mode 100644 index bdf810ac..00000000 --- a/apps/zhi-docs-vitepress/docs/.vitepress/theme/index.ts +++ /dev/null @@ -1,16 +0,0 @@ -// https://vitepress.dev/guide/custom-theme -import { h } from "vue" -import Theme from "vitepress/theme" -import "./style.css" - -export default { - ...Theme, - Layout: () => { - return h(Theme.Layout, null, { - // https://vitepress.dev/guide/extending-default-theme#layout-slots - }) - }, - enhanceApp({ app, router, siteData }) { - // ... - }, -} diff --git a/apps/zhi-docs-vitepress/docs/.vitepress/theme/style.css b/apps/zhi-docs-vitepress/docs/.vitepress/theme/style.css deleted file mode 100644 index c23c17ac..00000000 --- a/apps/zhi-docs-vitepress/docs/.vitepress/theme/style.css +++ /dev/null @@ -1,91 +0,0 @@ -/** - * Customize default theme styling by overriding CSS variables: - * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css - */ - -/** - * Colors - * -------------------------------------------------------------------------- */ - - :root { - --vp-c-brand: #646cff; - --vp-c-brand-light: #747bff; - --vp-c-brand-lighter: #9499ff; - --vp-c-brand-lightest: #bcc0ff; - --vp-c-brand-dark: #535bf2; - --vp-c-brand-darker: #454ce1; - --vp-c-brand-dimm: rgba(100, 108, 255, 0.08); -} - -/** - * Component: Button - * -------------------------------------------------------------------------- */ - -:root { - --vp-button-brand-border: var(--vp-c-brand-light); - --vp-button-brand-text: var(--vp-c-white); - --vp-button-brand-bg: var(--vp-c-brand); - --vp-button-brand-hover-border: var(--vp-c-brand-light); - --vp-button-brand-hover-text: var(--vp-c-white); - --vp-button-brand-hover-bg: var(--vp-c-brand-light); - --vp-button-brand-active-border: var(--vp-c-brand-light); - --vp-button-brand-active-text: var(--vp-c-white); - --vp-button-brand-active-bg: var(--vp-button-brand-bg); -} - -/** - * Component: Home - * -------------------------------------------------------------------------- */ - -:root { - --vp-home-hero-name-color: transparent; - --vp-home-hero-name-background: -webkit-linear-gradient( - 120deg, - #bd34fe 30%, - #41d1ff - ); - - --vp-home-hero-image-background-image: linear-gradient( - -45deg, - #bd34fe 50%, - #47caff 50% - ); - --vp-home-hero-image-filter: blur(40px); -} - -@media (min-width: 640px) { - :root { - --vp-home-hero-image-filter: blur(56px); - } -} - -@media (min-width: 960px) { - :root { - --vp-home-hero-image-filter: blur(72px); - } -} - -/** - * Component: Custom Block - * -------------------------------------------------------------------------- */ - -:root { - --vp-custom-block-tip-border: var(--vp-c-brand); - --vp-custom-block-tip-text: var(--vp-c-brand-darker); - --vp-custom-block-tip-bg: var(--vp-c-brand-dimm); -} - -.dark { - --vp-custom-block-tip-border: var(--vp-c-brand); - --vp-custom-block-tip-text: var(--vp-c-brand-lightest); - --vp-custom-block-tip-bg: var(--vp-c-brand-dimm); -} - -/** - * Component: Algolia - * -------------------------------------------------------------------------- */ - -.DocSearch { - --docsearch-primary-color: var(--vp-c-brand) !important; -} - diff --git a/apps/zhi-docs-vitepress/docs/api-examples.md b/apps/zhi-docs-vitepress/docs/api-examples.md deleted file mode 100644 index 6bd8bb5c..00000000 --- a/apps/zhi-docs-vitepress/docs/api-examples.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -outline: deep ---- - -# Runtime API Examples - -This page demonstrates usage of some of the runtime APIs provided by VitePress. - -The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: - -```md - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
-``` - - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
- -## More - -Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). diff --git a/apps/zhi-docs-vitepress/docs/api-nav.json b/apps/zhi-docs-vitepress/docs/api-nav.json deleted file mode 100644 index e7fb9554..00000000 --- a/apps/zhi-docs-vitepress/docs/api-nav.json +++ /dev/null @@ -1,56 +0,0 @@ -[ - { - "title": "child-package", - "url": "child-package/index.md", - "children": [ - { - "title": "Index", - "url": "child-package/module.child-package.md" - }, - { - "title": "Namespaces", - "children": [ - { - "title": "Validation", - "url": "child-package/namespaces/namespace.Validation/namespace.Validation.md", - "children": [ - { - "title": "Variables", - "children": [ - { - "title": "numberRegexp", - "url": "child-package/namespaces/namespace.Validation/variables/variable.numberRegexp.md" - } - ] - } - ] - } - ] - }, - { - "title": "Variables", - "children": [ - { - "title": "hello", - "url": "child-package/variables/variable.hello.md" - } - ] - } - ] - }, - { - "title": "child-package-2", - "url": "child-package-2/module.child-package-2.md", - "children": [ - { - "title": "Variables", - "children": [ - { - "title": "hello", - "url": "child-package-2/variables/variable.hello.md" - } - ] - } - ] - } -] \ No newline at end of file diff --git a/apps/zhi-docs-vitepress/docs/blog/index.md b/apps/zhi-docs-vitepress/docs/blog/index.md deleted file mode 100644 index 8615e34c..00000000 --- a/apps/zhi-docs-vitepress/docs/blog/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# This is blog - -- [zhi 0.1.1 is on the way](./zhi-0-1-0-is-on-the-way.md) \ No newline at end of file diff --git a/apps/zhi-docs-vitepress/docs/blog/zhi-0-1-0-is-on-the-way.md b/apps/zhi-docs-vitepress/docs/blog/zhi-0-1-0-is-on-the-way.md deleted file mode 100644 index 03b25cf2..00000000 --- a/apps/zhi-docs-vitepress/docs/blog/zhi-0-1-0-is-on-the-way.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar: true ---- - -# zhi 0.1.0 is on the way - -Zhi `0.1.0` is on the way, please wait ... - -## Modules - -- zhi-env -- zhi-log \ No newline at end of file diff --git a/apps/zhi-docs-vitepress/docs/index.md b/apps/zhi-docs-vitepress/docs/index.md deleted file mode 100644 index 4fc228c5..00000000 --- a/apps/zhi-docs-vitepress/docs/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Zhi Framework" - text: "" - tagline: The ultimate framework for building blog and theme - actions: - - theme: brand - text: Markdown Examples - link: /markdown-examples - - theme: alt - text: API Examples - link: /api-examples - -features: - - title: Feature A - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature B - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature C - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit ---- - diff --git a/apps/zhi-docs-vitepress/docs/markdown-examples.md b/apps/zhi-docs-vitepress/docs/markdown-examples.md deleted file mode 100644 index 8e55eb8a..00000000 --- a/apps/zhi-docs-vitepress/docs/markdown-examples.md +++ /dev/null @@ -1,85 +0,0 @@ -# Markdown Extension Examples - -This page demonstrates some of the built-in markdown extensions provided by VitePress. - -## Syntax Highlighting - -VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: - -**Input** - -```` -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` -```` - -**Output** - -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` - -## Custom Containers - -**Input** - -```md -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: -``` - -**Output** - -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: - -## More - -Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). diff --git a/apps/zhi-docs-vitepress/package-lock.json b/apps/zhi-docs-vitepress/package-lock.json deleted file mode 100644 index 4c01c6ea..00000000 --- a/apps/zhi-docs-vitepress/package-lock.json +++ /dev/null @@ -1,1890 +0,0 @@ -{ - "name": "vitepress", - "version": "1.0.0", - "lockfileVersion": 2, - "requires": true, - "packages": { - "": { - "name": "vitepress", - "version": "1.0.0", - "license": "ISC", - "devDependencies": { - "vitepress": "^1.0.0-alpha.75" - } - }, - "node_modules/@algolia/autocomplete-core": { - "version": "1.8.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-core/-/autocomplete-core-1.8.2.tgz", - "integrity": "sha512-mTeshsyFhAqw/ebqNsQpMtbnjr+qVOSKXArEj4K0d7sqc8It1XD0gkASwecm9mF/jlOQ4Z9RNg1HbdA8JPdRwQ==", - "dev": true, - "dependencies": { - "@algolia/autocomplete-shared": "1.8.2" - } - }, - "node_modules/@algolia/autocomplete-preset-algolia": { - "version": "1.8.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.8.2.tgz", - "integrity": "sha512-J0oTx4me6ZM9kIKPuL3lyU3aB8DEvpVvR6xWmHVROx5rOYJGQcZsdG4ozxwcOyiiu3qxMkIbzntnV1S1VWD8yA==", - "dev": true, - "dependencies": { - "@algolia/autocomplete-shared": "1.8.2" - }, - "peerDependencies": { - "@algolia/client-search": ">= 4.9.1 < 6", - "algoliasearch": ">= 4.9.1 < 6" - } - }, - "node_modules/@algolia/autocomplete-shared": { - "version": "1.8.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.8.2.tgz", - "integrity": "sha512-b6Z/X4MczChMcfhk6kfRmBzPgjoPzuS9KGR4AFsiLulLNRAAqhP+xZTKtMnZGhLuc61I20d5WqlId02AZvcO6g==", - "dev": true - }, - "node_modules/@algolia/cache-browser-local-storage": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.17.0.tgz", - "integrity": "sha512-myRSRZDIMYB8uCkO+lb40YKiYHi0fjpWRtJpR/dgkaiBlSD0plRyB6lLOh1XIfmMcSeBOqDE7y9m8xZMrXYfyQ==", - "dev": true, - "dependencies": { - "@algolia/cache-common": "4.17.0" - } - }, - "node_modules/@algolia/cache-common": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/cache-common/-/cache-common-4.17.0.tgz", - "integrity": "sha512-g8mXzkrcUBIPZaulAuqE7xyHhLAYAcF2xSch7d9dABheybaU3U91LjBX6eJTEB7XVhEsgK4Smi27vWtAJRhIKQ==", - "dev": true - }, - "node_modules/@algolia/cache-in-memory": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/cache-in-memory/-/cache-in-memory-4.17.0.tgz", - "integrity": "sha512-PT32ciC/xI8z919d0oknWVu3kMfTlhQn3MKxDln3pkn+yA7F7xrxSALysxquv+MhFfNAcrtQ/oVvQVBAQSHtdw==", - "dev": true, - "dependencies": { - "@algolia/cache-common": "4.17.0" - } - }, - "node_modules/@algolia/client-account": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-account/-/client-account-4.17.0.tgz", - "integrity": "sha512-sSEHx9GA6m7wrlsSMNBGfyzlIfDT2fkz2u7jqfCCd6JEEwmxt8emGmxAU/0qBfbhRSuGvzojoLJlr83BSZAKjA==", - "dev": true, - "dependencies": { - "@algolia/client-common": "4.17.0", - "@algolia/client-search": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "node_modules/@algolia/client-analytics": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-4.17.0.tgz", - "integrity": "sha512-84ooP8QA3mQ958hQ9wozk7hFUbAO+81CX1CjAuerxBqjKIInh1fOhXKTaku05O/GHBvcfExpPLIQuSuLYziBXQ==", - "dev": true, - "dependencies": { - "@algolia/client-common": "4.17.0", - "@algolia/client-search": "4.17.0", - "@algolia/requester-common": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "node_modules/@algolia/client-common": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-common/-/client-common-4.17.0.tgz", - "integrity": "sha512-jHMks0ZFicf8nRDn6ma8DNNsdwGgP/NKiAAL9z6rS7CymJ7L0+QqTJl3rYxRW7TmBhsUH40wqzmrG6aMIN/DrQ==", - "dev": true, - "dependencies": { - "@algolia/requester-common": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "node_modules/@algolia/client-personalization": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-4.17.0.tgz", - "integrity": "sha512-RMzN4dZLIta1YuwT7QC9o+OeGz2cU6eTOlGNE/6RcUBLOU3l9tkCOdln5dPE2jp8GZXPl2yk54b2nSs1+pAjqw==", - "dev": true, - "dependencies": { - "@algolia/client-common": "4.17.0", - "@algolia/requester-common": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "node_modules/@algolia/client-search": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-4.17.0.tgz", - "integrity": "sha512-x4P2wKrrRIXszT8gb7eWsMHNNHAJs0wE7/uqbufm4tZenAp+hwU/hq5KVsY50v+PfwM0LcDwwn/1DroujsTFoA==", - "dev": true, - "dependencies": { - "@algolia/client-common": "4.17.0", - "@algolia/requester-common": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "node_modules/@algolia/logger-common": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/logger-common/-/logger-common-4.17.0.tgz", - "integrity": "sha512-DGuoZqpTmIKJFDeyAJ7M8E/LOenIjWiOsg1XJ1OqAU/eofp49JfqXxbfgctlVZVmDABIyOz8LqEoJ6ZP4DTyvw==", - "dev": true - }, - "node_modules/@algolia/logger-console": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/logger-console/-/logger-console-4.17.0.tgz", - "integrity": "sha512-zMPvugQV/gbXUvWBCzihw6m7oxIKp48w37QBIUu/XqQQfxhjoOE9xyfJr1KldUt5FrYOKZJVsJaEjTsu+bIgQg==", - "dev": true, - "dependencies": { - "@algolia/logger-common": "4.17.0" - } - }, - "node_modules/@algolia/requester-browser-xhr": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.17.0.tgz", - "integrity": "sha512-aSOX/smauyTkP21Pf52pJ1O2LmNFJ5iHRIzEeTh0mwBeADO4GdG94cAWDILFA9rNblq/nK3EDh3+UyHHjplZ1A==", - "dev": true, - "dependencies": { - "@algolia/requester-common": "4.17.0" - } - }, - "node_modules/@algolia/requester-common": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-common/-/requester-common-4.17.0.tgz", - "integrity": "sha512-XJjmWFEUlHu0ijvcHBoixuXfEoiRUdyzQM6YwTuB8usJNIgShua8ouFlRWF8iCeag0vZZiUm4S2WCVBPkdxFgg==", - "dev": true - }, - "node_modules/@algolia/requester-node-http": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-4.17.0.tgz", - "integrity": "sha512-bpb/wDA1aC6WxxM8v7TsFspB7yBN3nqCGs2H1OADolQR/hiAIjAxusbuMxVbRFOdaUvAIqioIIkWvZdpYNIn8w==", - "dev": true, - "dependencies": { - "@algolia/requester-common": "4.17.0" - } - }, - "node_modules/@algolia/transporter": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/transporter/-/transporter-4.17.0.tgz", - "integrity": "sha512-6xL6H6fe+Fi0AEP3ziSgC+G04RK37iRb4uUUqVAH9WPYFI8g+LYFq6iv5HS8Cbuc5TTut+Bwj6G+dh/asdb9uA==", - "dev": true, - "dependencies": { - "@algolia/cache-common": "4.17.0", - "@algolia/logger-common": "4.17.0", - "@algolia/requester-common": "4.17.0" - } - }, - "node_modules/@babel/parser": { - "version": "7.21.8", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.21.8.tgz", - "integrity": "sha512-6zavDGdzG3gUqAdWvlLFfk+36RilI+Pwyuuh7HItyeScCWP3k6i8vKclAQ0bM/0y/Kz/xiwvxhMv9MgTJP5gmA==", - "dev": true, - "bin": { - "parser": "bin/babel-parser.js" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@docsearch/css": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/@docsearch/css/-/css-3.3.4.tgz", - "integrity": "sha512-vDwCDoVXDgopw/hvr0zEADew2wWaGP8Qq0Bxhgii1Ewz2t4fQeyJwIRN/mWADeLFYPVkpz8TpEbxya/i6Tm0WA==", - "dev": true - }, - "node_modules/@docsearch/js": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/@docsearch/js/-/js-3.3.4.tgz", - "integrity": "sha512-Xd2saBziXJ1UuVpcDz94zAFEFAM6ap993agh0za2e3LDZLhaW993b1f9gyUL4e1CZLsR076tztG2un2gVncvpA==", - "dev": true, - "dependencies": { - "@docsearch/react": "3.3.4", - "preact": "^10.0.0" - } - }, - "node_modules/@docsearch/react": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/@docsearch/react/-/react-3.3.4.tgz", - "integrity": "sha512-aeOf1WC5zMzBEi2SI6WWznOmIo9rnpN4p7a3zHXxowVciqlI4HsZGtOR9nFOufLeolv7HibwLlaM0oyUqJxasw==", - "dev": true, - "dependencies": { - "@algolia/autocomplete-core": "1.8.2", - "@algolia/autocomplete-preset-algolia": "1.8.2", - "@docsearch/css": "3.3.4", - "algoliasearch": "^4.0.0" - }, - "peerDependencies": { - "@types/react": ">= 16.8.0 < 19.0.0", - "react": ">= 16.8.0 < 19.0.0", - "react-dom": ">= 16.8.0 < 19.0.0" - }, - "peerDependenciesMeta": { - "@types/react": { - "optional": true - }, - "react": { - "optional": true - }, - "react-dom": { - "optional": true - } - } - }, - "node_modules/@esbuild/android-arm": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.17.18.tgz", - "integrity": "sha512-EmwL+vUBZJ7mhFCs5lA4ZimpUH3WMAoqvOIYhVQwdIgSpHC8ImHdsRyhHAVxpDYUSm0lWvd63z0XH1IlImS2Qw==", - "cpu": [ - "arm" - ], - "dev": true, - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/android-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.17.18.tgz", - "integrity": "sha512-/iq0aK0eeHgSC3z55ucMAHO05OIqmQehiGay8eP5l/5l+iEr4EIbh4/MI8xD9qRFjqzgkc0JkX0LculNC9mXBw==", - "cpu": [ - "arm64" - ], - "dev": true, - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/android-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.17.18.tgz", - "integrity": "sha512-x+0efYNBF3NPW2Xc5bFOSFW7tTXdAcpfEg2nXmxegm4mJuVeS+i109m/7HMiOQ6M12aVGGFlqJX3RhNdYM2lWg==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/darwin-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.17.18.tgz", - "integrity": "sha512-6tY+djEAdF48M1ONWnQb1C+6LiXrKjmqjzPNPWXhu/GzOHTHX2nh8Mo2ZAmBFg0kIodHhciEgUBtcYCAIjGbjQ==", - "cpu": [ - "arm64" - ], - "dev": true, - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/darwin-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.17.18.tgz", - "integrity": "sha512-Qq84ykvLvya3dO49wVC9FFCNUfSrQJLbxhoQk/TE1r6MjHo3sFF2tlJCwMjhkBVq3/ahUisj7+EpRSz0/+8+9A==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/freebsd-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.17.18.tgz", - "integrity": "sha512-fw/ZfxfAzuHfaQeMDhbzxp9mc+mHn1Y94VDHFHjGvt2Uxl10mT4CDavHm+/L9KG441t1QdABqkVYwakMUeyLRA==", - "cpu": [ - "arm64" - ], - "dev": true, - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/freebsd-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.17.18.tgz", - "integrity": "sha512-FQFbRtTaEi8ZBi/A6kxOC0V0E9B/97vPdYjY9NdawyLd4Qk5VD5g2pbWN2VR1c0xhzcJm74HWpObPszWC+qTew==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-arm": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.17.18.tgz", - "integrity": "sha512-jW+UCM40LzHcouIaqv3e/oRs0JM76JfhHjCavPxMUti7VAPh8CaGSlS7cmyrdpzSk7A+8f0hiedHqr/LMnfijg==", - "cpu": [ - "arm" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.17.18.tgz", - "integrity": "sha512-R7pZvQZFOY2sxUG8P6A21eq6q+eBv7JPQYIybHVf1XkQYC+lT7nDBdC7wWKTrbvMXKRaGudp/dzZCwL/863mZQ==", - "cpu": [ - "arm64" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-ia32": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.17.18.tgz", - "integrity": "sha512-ygIMc3I7wxgXIxk6j3V00VlABIjq260i967Cp9BNAk5pOOpIXmd1RFQJQX9Io7KRsthDrQYrtcx7QCof4o3ZoQ==", - "cpu": [ - "ia32" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-loong64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.17.18.tgz", - "integrity": "sha512-bvPG+MyFs5ZlwYclCG1D744oHk1Pv7j8psF5TfYx7otCVmcJsEXgFEhQkbhNW8otDHL1a2KDINW20cfCgnzgMQ==", - "cpu": [ - "loong64" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-mips64el": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.17.18.tgz", - "integrity": "sha512-oVqckATOAGuiUOa6wr8TXaVPSa+6IwVJrGidmNZS1cZVx0HqkTMkqFGD2HIx9H1RvOwFeWYdaYbdY6B89KUMxA==", - "cpu": [ - "mips64el" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-ppc64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.17.18.tgz", - "integrity": "sha512-3dLlQO+b/LnQNxgH4l9rqa2/IwRJVN9u/bK63FhOPB4xqiRqlQAU0qDU3JJuf0BmaH0yytTBdoSBHrb2jqc5qQ==", - "cpu": [ - "ppc64" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-riscv64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.17.18.tgz", - "integrity": "sha512-/x7leOyDPjZV3TcsdfrSI107zItVnsX1q2nho7hbbQoKnmoeUWjs+08rKKt4AUXju7+3aRZSsKrJtaRmsdL1xA==", - "cpu": [ - "riscv64" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-s390x": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.17.18.tgz", - "integrity": "sha512-cX0I8Q9xQkL/6F5zWdYmVf5JSQt+ZfZD2bJudZrWD+4mnUvoZ3TDDXtDX2mUaq6upMFv9FlfIh4Gfun0tbGzuw==", - "cpu": [ - "s390x" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/linux-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.17.18.tgz", - "integrity": "sha512-66RmRsPlYy4jFl0vG80GcNRdirx4nVWAzJmXkevgphP1qf4dsLQCpSKGM3DUQCojwU1hnepI63gNZdrr02wHUA==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/netbsd-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.17.18.tgz", - "integrity": "sha512-95IRY7mI2yrkLlTLb1gpDxdC5WLC5mZDi+kA9dmM5XAGxCME0F8i4bYH4jZreaJ6lIZ0B8hTrweqG1fUyW7jbg==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/openbsd-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.17.18.tgz", - "integrity": "sha512-WevVOgcng+8hSZ4Q3BKL3n1xTv5H6Nb53cBrtzzEjDbbnOmucEVcZeGCsCOi9bAOcDYEeBZbD2SJNBxlfP3qiA==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/sunos-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.17.18.tgz", - "integrity": "sha512-Rzf4QfQagnwhQXVBS3BYUlxmEbcV7MY+BH5vfDZekU5eYpcffHSyjU8T0xucKVuOcdCsMo+Ur5wmgQJH2GfNrg==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "sunos" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/win32-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.17.18.tgz", - "integrity": "sha512-Kb3Ko/KKaWhjeAm2YoT/cNZaHaD1Yk/pa3FTsmqo9uFh1D1Rfco7BBLIPdDOozrObj2sahslFuAQGvWbgWldAg==", - "cpu": [ - "arm64" - ], - "dev": true, - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/win32-ia32": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.17.18.tgz", - "integrity": "sha512-0/xUMIdkVHwkvxfbd5+lfG7mHOf2FRrxNbPiKWg9C4fFrB8H0guClmaM3BFiRUYrznVoyxTIyC/Ou2B7QQSwmw==", - "cpu": [ - "ia32" - ], - "dev": true, - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@esbuild/win32-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.17.18.tgz", - "integrity": "sha512-qU25Ma1I3NqTSHJUOKi9sAH1/Mzuvlke0ioMJRthLXKm7JiSKVwFghlGbDLOO2sARECGhja4xYfRAZNPAkooYg==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/@types/web-bluetooth": { - "version": "0.0.17", - "resolved": "https://registry.npmjs.org/@types/web-bluetooth/-/web-bluetooth-0.0.17.tgz", - "integrity": "sha512-4p9vcSmxAayx72yn70joFoL44c9MO/0+iVEBIQXe3v2h2SiAsEIo/G5v6ObFWvNKRFjbrVadNf9LqEEZeQPzdA==", - "dev": true - }, - "node_modules/@vitejs/plugin-vue": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/@vitejs/plugin-vue/-/plugin-vue-4.2.1.tgz", - "integrity": "sha512-ZTZjzo7bmxTRTkb8GSTwkPOYDIP7pwuyV+RV53c9PYUouwcbkIZIvWvNWlX2b1dYZqtOv7D6iUAnJLVNGcLrSw==", - "dev": true, - "engines": { - "node": "^14.18.0 || >=16.0.0" - }, - "peerDependencies": { - "vite": "^4.0.0", - "vue": "^3.2.25" - } - }, - "node_modules/@vue/compiler-core": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/compiler-core/-/compiler-core-3.2.47.tgz", - "integrity": "sha512-p4D7FDnQb7+YJmO2iPEv0SQNeNzcbHdGByJDsT4lynf63AFkOTFN07HsiRSvjGo0QrxR/o3d0hUyNCUnBU2Tig==", - "dev": true, - "dependencies": { - "@babel/parser": "^7.16.4", - "@vue/shared": "3.2.47", - "estree-walker": "^2.0.2", - "source-map": "^0.6.1" - } - }, - "node_modules/@vue/compiler-dom": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/compiler-dom/-/compiler-dom-3.2.47.tgz", - "integrity": "sha512-dBBnEHEPoftUiS03a4ggEig74J2YBZ2UIeyfpcRM2tavgMWo4bsEfgCGsu+uJIL/vax9S+JztH8NmQerUo7shQ==", - "dev": true, - "dependencies": { - "@vue/compiler-core": "3.2.47", - "@vue/shared": "3.2.47" - } - }, - "node_modules/@vue/compiler-sfc": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/compiler-sfc/-/compiler-sfc-3.2.47.tgz", - "integrity": "sha512-rog05W+2IFfxjMcFw10tM9+f7i/+FFpZJJ5XHX72NP9eC2uRD+42M3pYcQqDXVYoj74kHMSEdQ/WmCjt8JFksQ==", - "dev": true, - "dependencies": { - "@babel/parser": "^7.16.4", - "@vue/compiler-core": "3.2.47", - "@vue/compiler-dom": "3.2.47", - "@vue/compiler-ssr": "3.2.47", - "@vue/reactivity-transform": "3.2.47", - "@vue/shared": "3.2.47", - "estree-walker": "^2.0.2", - "magic-string": "^0.25.7", - "postcss": "^8.1.10", - "source-map": "^0.6.1" - } - }, - "node_modules/@vue/compiler-ssr": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/compiler-ssr/-/compiler-ssr-3.2.47.tgz", - "integrity": "sha512-wVXC+gszhulcMD8wpxMsqSOpvDZ6xKXSVWkf50Guf/S+28hTAXPDYRTbLQ3EDkOP5Xz/+SY37YiwDquKbJOgZw==", - "dev": true, - "dependencies": { - "@vue/compiler-dom": "3.2.47", - "@vue/shared": "3.2.47" - } - }, - "node_modules/@vue/devtools-api": { - "version": "6.5.0", - "resolved": "https://registry.npmjs.org/@vue/devtools-api/-/devtools-api-6.5.0.tgz", - "integrity": "sha512-o9KfBeaBmCKl10usN4crU53fYtC1r7jJwdGKjPT24t348rHxgfpZ0xL3Xm/gLUYnc0oTp8LAmrxOeLyu6tbk2Q==", - "dev": true - }, - "node_modules/@vue/reactivity": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/reactivity/-/reactivity-3.2.47.tgz", - "integrity": "sha512-7khqQ/75oyyg+N/e+iwV6lpy1f5wq759NdlS1fpAhFXa8VeAIKGgk2E/C4VF59lx5b+Ezs5fpp/5WsRYXQiKxQ==", - "dev": true, - "dependencies": { - "@vue/shared": "3.2.47" - } - }, - "node_modules/@vue/reactivity-transform": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/reactivity-transform/-/reactivity-transform-3.2.47.tgz", - "integrity": "sha512-m8lGXw8rdnPVVIdIFhf0LeQ/ixyHkH5plYuS83yop5n7ggVJU+z5v0zecwEnX7fa7HNLBhh2qngJJkxpwEEmYA==", - "dev": true, - "dependencies": { - "@babel/parser": "^7.16.4", - "@vue/compiler-core": "3.2.47", - "@vue/shared": "3.2.47", - "estree-walker": "^2.0.2", - "magic-string": "^0.25.7" - } - }, - "node_modules/@vue/runtime-core": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/runtime-core/-/runtime-core-3.2.47.tgz", - "integrity": "sha512-RZxbLQIRB/K0ev0K9FXhNbBzT32H9iRtYbaXb0ZIz2usLms/D55dJR2t6cIEUn6vyhS3ALNvNthI+Q95C+NOpA==", - "dev": true, - "dependencies": { - "@vue/reactivity": "3.2.47", - "@vue/shared": "3.2.47" - } - }, - "node_modules/@vue/runtime-dom": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/runtime-dom/-/runtime-dom-3.2.47.tgz", - "integrity": "sha512-ArXrFTjS6TsDei4qwNvgrdmHtD930KgSKGhS5M+j8QxXrDJYLqYw4RRcDy1bz1m1wMmb6j+zGLifdVHtkXA7gA==", - "dev": true, - "dependencies": { - "@vue/runtime-core": "3.2.47", - "@vue/shared": "3.2.47", - "csstype": "^2.6.8" - } - }, - "node_modules/@vue/server-renderer": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/server-renderer/-/server-renderer-3.2.47.tgz", - "integrity": "sha512-dN9gc1i8EvmP9RCzvneONXsKfBRgqFeFZLurmHOveL7oH6HiFXJw5OGu294n1nHc/HMgTy6LulU/tv5/A7f/LA==", - "dev": true, - "dependencies": { - "@vue/compiler-ssr": "3.2.47", - "@vue/shared": "3.2.47" - }, - "peerDependencies": { - "vue": "3.2.47" - } - }, - "node_modules/@vue/shared": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/shared/-/shared-3.2.47.tgz", - "integrity": "sha512-BHGyyGN3Q97EZx0taMQ+OLNuZcW3d37ZEVmEAyeoA9ERdGvm9Irc/0Fua8SNyOtV1w6BS4q25wbMzJujO9HIfQ==", - "dev": true - }, - "node_modules/@vueuse/core": { - "version": "10.1.2", - "resolved": "https://registry.npmjs.org/@vueuse/core/-/core-10.1.2.tgz", - "integrity": "sha512-roNn8WuerI56A5uiTyF/TEYX0Y+VKlhZAF94unUfdhbDUI+NfwQMn4FUnUscIRUhv3344qvAghopU4bzLPNFlA==", - "dev": true, - "dependencies": { - "@types/web-bluetooth": "^0.0.17", - "@vueuse/metadata": "10.1.2", - "@vueuse/shared": "10.1.2", - "vue-demi": ">=0.14.0" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" - } - }, - "node_modules/@vueuse/core/node_modules/vue-demi": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/vue-demi/-/vue-demi-0.14.0.tgz", - "integrity": "sha512-gt58r2ogsNQeVoQ3EhoUAvUsH9xviydl0dWJj7dabBC/2L4uBId7ujtCwDRD0JhkGsV1i0CtfLAeyYKBht9oWg==", - "dev": true, - "hasInstallScript": true, - "bin": { - "vue-demi-fix": "bin/vue-demi-fix.js", - "vue-demi-switch": "bin/vue-demi-switch.js" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" - }, - "peerDependencies": { - "@vue/composition-api": "^1.0.0-rc.1", - "vue": "^3.0.0-0 || ^2.6.0" - }, - "peerDependenciesMeta": { - "@vue/composition-api": { - "optional": true - } - } - }, - "node_modules/@vueuse/metadata": { - "version": "10.1.2", - "resolved": "https://registry.npmjs.org/@vueuse/metadata/-/metadata-10.1.2.tgz", - "integrity": "sha512-3mc5BqN9aU2SqBeBuWE7ne4OtXHoHKggNgxZR2K+zIW4YLsy6xoZ4/9vErQs6tvoKDX6QAqm3lvsrv0mczAwIQ==", - "dev": true, - "funding": { - "url": "https://github.com/sponsors/antfu" - } - }, - "node_modules/@vueuse/shared": { - "version": "10.1.2", - "resolved": "https://registry.npmjs.org/@vueuse/shared/-/shared-10.1.2.tgz", - "integrity": "sha512-1uoUTPBlgyscK9v6ScGeVYDDzlPSFXBlxuK7SfrDGyUTBiznb3mNceqhwvZHjtDRELZEN79V5uWPTF1VDV8svA==", - "dev": true, - "dependencies": { - "vue-demi": ">=0.14.0" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" - } - }, - "node_modules/@vueuse/shared/node_modules/vue-demi": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/vue-demi/-/vue-demi-0.14.0.tgz", - "integrity": "sha512-gt58r2ogsNQeVoQ3EhoUAvUsH9xviydl0dWJj7dabBC/2L4uBId7ujtCwDRD0JhkGsV1i0CtfLAeyYKBht9oWg==", - "dev": true, - "hasInstallScript": true, - "bin": { - "vue-demi-fix": "bin/vue-demi-fix.js", - "vue-demi-switch": "bin/vue-demi-switch.js" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" - }, - "peerDependencies": { - "@vue/composition-api": "^1.0.0-rc.1", - "vue": "^3.0.0-0 || ^2.6.0" - }, - "peerDependenciesMeta": { - "@vue/composition-api": { - "optional": true - } - } - }, - "node_modules/algoliasearch": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-4.17.0.tgz", - "integrity": "sha512-JMRh2Mw6sEnVMiz6+APsi7lx9a2jiDFF+WUtANaUVCv6uSU9UOLdo5h9K3pdP6frRRybaM2fX8b1u0nqICS9aA==", - "dev": true, - "dependencies": { - "@algolia/cache-browser-local-storage": "4.17.0", - "@algolia/cache-common": "4.17.0", - "@algolia/cache-in-memory": "4.17.0", - "@algolia/client-account": "4.17.0", - "@algolia/client-analytics": "4.17.0", - "@algolia/client-common": "4.17.0", - "@algolia/client-personalization": "4.17.0", - "@algolia/client-search": "4.17.0", - "@algolia/logger-common": "4.17.0", - "@algolia/logger-console": "4.17.0", - "@algolia/requester-browser-xhr": "4.17.0", - "@algolia/requester-common": "4.17.0", - "@algolia/requester-node-http": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "node_modules/ansi-sequence-parser": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.0.tgz", - "integrity": "sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ==", - "dev": true - }, - "node_modules/body-scroll-lock": { - "version": "4.0.0-beta.0", - "resolved": "https://registry.npmjs.org/body-scroll-lock/-/body-scroll-lock-4.0.0-beta.0.tgz", - "integrity": "sha512-a7tP5+0Mw3YlUJcGAKUqIBkYYGlYxk2fnCasq/FUph1hadxlTRjF+gAcZksxANnaMnALjxEddmSi/H3OR8ugcQ==", - "dev": true - }, - "node_modules/csstype": { - "version": "2.6.21", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-2.6.21.tgz", - "integrity": "sha512-Z1PhmomIfypOpoMjRQB70jfvy/wxT50qW08YXO5lMIJkrdq4yOTR+AW7FqutScmB9NkLwxo+jU+kZLbofZZq/w==", - "dev": true - }, - "node_modules/esbuild": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.17.18.tgz", - "integrity": "sha512-z1lix43jBs6UKjcZVKOw2xx69ffE2aG0PygLL5qJ9OS/gy0Ewd1gW/PUQIOIQGXBHWNywSc0floSKoMFF8aK2w==", - "dev": true, - "hasInstallScript": true, - "bin": { - "esbuild": "bin/esbuild" - }, - "engines": { - "node": ">=12" - }, - "optionalDependencies": { - "@esbuild/android-arm": "0.17.18", - "@esbuild/android-arm64": "0.17.18", - "@esbuild/android-x64": "0.17.18", - "@esbuild/darwin-arm64": "0.17.18", - "@esbuild/darwin-x64": "0.17.18", - "@esbuild/freebsd-arm64": "0.17.18", - "@esbuild/freebsd-x64": "0.17.18", - "@esbuild/linux-arm": "0.17.18", - "@esbuild/linux-arm64": "0.17.18", - "@esbuild/linux-ia32": "0.17.18", - "@esbuild/linux-loong64": "0.17.18", - "@esbuild/linux-mips64el": "0.17.18", - "@esbuild/linux-ppc64": "0.17.18", - "@esbuild/linux-riscv64": "0.17.18", - "@esbuild/linux-s390x": "0.17.18", - "@esbuild/linux-x64": "0.17.18", - "@esbuild/netbsd-x64": "0.17.18", - "@esbuild/openbsd-x64": "0.17.18", - "@esbuild/sunos-x64": "0.17.18", - "@esbuild/win32-arm64": "0.17.18", - "@esbuild/win32-ia32": "0.17.18", - "@esbuild/win32-x64": "0.17.18" - } - }, - "node_modules/estree-walker": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", - "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", - "dev": true - }, - "node_modules/fsevents": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz", - "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==", - "dev": true, - "hasInstallScript": true, - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": "^8.16.0 || ^10.6.0 || >=11.0.0" - } - }, - "node_modules/jsonc-parser": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz", - "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", - "dev": true - }, - "node_modules/magic-string": { - "version": "0.25.9", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", - "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", - "dev": true, - "dependencies": { - "sourcemap-codec": "^1.4.8" - } - }, - "node_modules/mark.js": { - "version": "8.11.1", - "resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz", - "integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==", - "dev": true - }, - "node_modules/minisearch": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/minisearch/-/minisearch-6.0.1.tgz", - "integrity": "sha512-Ly1w0nHKnlhAAh6/BF/+9NgzXfoJxaJ8nhopFhQ3NcvFJrFIL+iCg9gw9e9UMBD+XIsp/RyznJ/o5UIe5Kw+kg==", - "dev": true - }, - "node_modules/nanoid": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", - "integrity": "sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "bin": { - "nanoid": "bin/nanoid.cjs" - }, - "engines": { - "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" - } - }, - "node_modules/picocolors": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", - "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", - "dev": true - }, - "node_modules/postcss": { - "version": "8.4.23", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.23.tgz", - "integrity": "sha512-bQ3qMcpF6A/YjR55xtoTr0jGOlnPOKAIMdOWiv0EIT6HVPEaJiJB4NLljSbiHoC2RX7DN5Uvjtpbg1NPdwv1oA==", - "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/postcss" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "dependencies": { - "nanoid": "^3.3.6", - "picocolors": "^1.0.0", - "source-map-js": "^1.0.2" - }, - "engines": { - "node": "^10 || ^12 || >=14" - } - }, - "node_modules/preact": { - "version": "10.13.2", - "resolved": "https://registry.npmjs.org/preact/-/preact-10.13.2.tgz", - "integrity": "sha512-q44QFLhOhty2Bd0Y46fnYW0gD/cbVM9dUVtNTDKPcdXSMA7jfY+Jpd6rk3GB0lcQss0z5s/6CmVP0Z/hV+g6pw==", - "dev": true, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/preact" - } - }, - "node_modules/rollup": { - "version": "3.21.3", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.21.3.tgz", - "integrity": "sha512-VnPfEG51nIv2xPLnZaekkuN06q9ZbnyDcLkaBdJa/W7UddyhOfMP2yOPziYQfeY7k++fZM8FdQIummFN5y14kA==", - "dev": true, - "bin": { - "rollup": "dist/bin/rollup" - }, - "engines": { - "node": ">=14.18.0", - "npm": ">=8.0.0" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" - } - }, - "node_modules/shiki": { - "version": "0.14.2", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.2.tgz", - "integrity": "sha512-ltSZlSLOuSY0M0Y75KA+ieRaZ0Trf5Wl3gutE7jzLuIcWxLp5i/uEnLoQWNvgKXQ5OMpGkJnVMRLAuzjc0LJ2A==", - "dev": true, - "dependencies": { - "ansi-sequence-parser": "^1.1.0", - "jsonc-parser": "^3.2.0", - "vscode-oniguruma": "^1.7.0", - "vscode-textmate": "^8.0.0" - } - }, - "node_modules/source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/source-map-js": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz", - "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/sourcemap-codec": { - "version": "1.4.8", - "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", - "integrity": "sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==", - "deprecated": "Please use @jridgewell/sourcemap-codec instead", - "dev": true - }, - "node_modules/vite": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-4.3.4.tgz", - "integrity": "sha512-f90aqGBoxSFxWph2b39ae2uHAxm5jFBBdnfueNxZAT1FTpM13ccFQExCaKbR2xFW5atowjleRniQ7onjJ22QEg==", - "dev": true, - "dependencies": { - "esbuild": "^0.17.5", - "postcss": "^8.4.23", - "rollup": "^3.21.0" - }, - "bin": { - "vite": "bin/vite.js" - }, - "engines": { - "node": "^14.18.0 || >=16.0.0" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" - }, - "peerDependencies": { - "@types/node": ">= 14", - "less": "*", - "sass": "*", - "stylus": "*", - "sugarss": "*", - "terser": "^5.4.0" - }, - "peerDependenciesMeta": { - "@types/node": { - "optional": true - }, - "less": { - "optional": true - }, - "sass": { - "optional": true - }, - "stylus": { - "optional": true - }, - "sugarss": { - "optional": true - }, - "terser": { - "optional": true - } - } - }, - "node_modules/vitepress": { - "version": "1.0.0-alpha.75", - "resolved": "https://registry.npmjs.org/vitepress/-/vitepress-1.0.0-alpha.75.tgz", - "integrity": "sha512-twpPZ/6UnDR8X0Nmj767KwKhXlTQQM9V/J1i2BP9ryO29/w4hpxBfEum6nvfpNhJ4H3h+cIhwzAK/e9crZ6HEQ==", - "dev": true, - "dependencies": { - "@docsearch/css": "^3.3.4", - "@docsearch/js": "^3.3.4", - "@vitejs/plugin-vue": "^4.2.1", - "@vue/devtools-api": "^6.5.0", - "@vueuse/core": "^10.1.0", - "body-scroll-lock": "4.0.0-beta.0", - "mark.js": "8.11.1", - "minisearch": "^6.0.1", - "shiki": "^0.14.2", - "vite": "^4.3.3", - "vue": "^3.2.47" - }, - "bin": { - "vitepress": "bin/vitepress.js" - } - }, - "node_modules/vscode-oniguruma": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", - "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", - "dev": true - }, - "node_modules/vscode-textmate": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", - "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", - "dev": true - }, - "node_modules/vue": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/vue/-/vue-3.2.47.tgz", - "integrity": "sha512-60188y/9Dc9WVrAZeUVSDxRQOZ+z+y5nO2ts9jWXSTkMvayiWxCWOWtBQoYjLeccfXkiiPZWAHcV+WTPhkqJHQ==", - "dev": true, - "dependencies": { - "@vue/compiler-dom": "3.2.47", - "@vue/compiler-sfc": "3.2.47", - "@vue/runtime-dom": "3.2.47", - "@vue/server-renderer": "3.2.47", - "@vue/shared": "3.2.47" - } - } - }, - "dependencies": { - "@algolia/autocomplete-core": { - "version": "1.8.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-core/-/autocomplete-core-1.8.2.tgz", - "integrity": "sha512-mTeshsyFhAqw/ebqNsQpMtbnjr+qVOSKXArEj4K0d7sqc8It1XD0gkASwecm9mF/jlOQ4Z9RNg1HbdA8JPdRwQ==", - "dev": true, - "requires": { - "@algolia/autocomplete-shared": "1.8.2" - } - }, - "@algolia/autocomplete-preset-algolia": { - "version": "1.8.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.8.2.tgz", - "integrity": "sha512-J0oTx4me6ZM9kIKPuL3lyU3aB8DEvpVvR6xWmHVROx5rOYJGQcZsdG4ozxwcOyiiu3qxMkIbzntnV1S1VWD8yA==", - "dev": true, - "requires": { - "@algolia/autocomplete-shared": "1.8.2" - } - }, - "@algolia/autocomplete-shared": { - "version": "1.8.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.8.2.tgz", - "integrity": "sha512-b6Z/X4MczChMcfhk6kfRmBzPgjoPzuS9KGR4AFsiLulLNRAAqhP+xZTKtMnZGhLuc61I20d5WqlId02AZvcO6g==", - "dev": true - }, - "@algolia/cache-browser-local-storage": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.17.0.tgz", - "integrity": "sha512-myRSRZDIMYB8uCkO+lb40YKiYHi0fjpWRtJpR/dgkaiBlSD0plRyB6lLOh1XIfmMcSeBOqDE7y9m8xZMrXYfyQ==", - "dev": true, - "requires": { - "@algolia/cache-common": "4.17.0" - } - }, - "@algolia/cache-common": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/cache-common/-/cache-common-4.17.0.tgz", - "integrity": "sha512-g8mXzkrcUBIPZaulAuqE7xyHhLAYAcF2xSch7d9dABheybaU3U91LjBX6eJTEB7XVhEsgK4Smi27vWtAJRhIKQ==", - "dev": true - }, - "@algolia/cache-in-memory": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/cache-in-memory/-/cache-in-memory-4.17.0.tgz", - "integrity": "sha512-PT32ciC/xI8z919d0oknWVu3kMfTlhQn3MKxDln3pkn+yA7F7xrxSALysxquv+MhFfNAcrtQ/oVvQVBAQSHtdw==", - "dev": true, - "requires": { - "@algolia/cache-common": "4.17.0" - } - }, - "@algolia/client-account": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-account/-/client-account-4.17.0.tgz", - "integrity": "sha512-sSEHx9GA6m7wrlsSMNBGfyzlIfDT2fkz2u7jqfCCd6JEEwmxt8emGmxAU/0qBfbhRSuGvzojoLJlr83BSZAKjA==", - "dev": true, - "requires": { - "@algolia/client-common": "4.17.0", - "@algolia/client-search": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "@algolia/client-analytics": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-4.17.0.tgz", - "integrity": "sha512-84ooP8QA3mQ958hQ9wozk7hFUbAO+81CX1CjAuerxBqjKIInh1fOhXKTaku05O/GHBvcfExpPLIQuSuLYziBXQ==", - "dev": true, - "requires": { - "@algolia/client-common": "4.17.0", - "@algolia/client-search": "4.17.0", - "@algolia/requester-common": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "@algolia/client-common": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-common/-/client-common-4.17.0.tgz", - "integrity": "sha512-jHMks0ZFicf8nRDn6ma8DNNsdwGgP/NKiAAL9z6rS7CymJ7L0+QqTJl3rYxRW7TmBhsUH40wqzmrG6aMIN/DrQ==", - "dev": true, - "requires": { - "@algolia/requester-common": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "@algolia/client-personalization": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-4.17.0.tgz", - "integrity": "sha512-RMzN4dZLIta1YuwT7QC9o+OeGz2cU6eTOlGNE/6RcUBLOU3l9tkCOdln5dPE2jp8GZXPl2yk54b2nSs1+pAjqw==", - "dev": true, - "requires": { - "@algolia/client-common": "4.17.0", - "@algolia/requester-common": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "@algolia/client-search": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-4.17.0.tgz", - "integrity": "sha512-x4P2wKrrRIXszT8gb7eWsMHNNHAJs0wE7/uqbufm4tZenAp+hwU/hq5KVsY50v+PfwM0LcDwwn/1DroujsTFoA==", - "dev": true, - "requires": { - "@algolia/client-common": "4.17.0", - "@algolia/requester-common": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "@algolia/logger-common": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/logger-common/-/logger-common-4.17.0.tgz", - "integrity": "sha512-DGuoZqpTmIKJFDeyAJ7M8E/LOenIjWiOsg1XJ1OqAU/eofp49JfqXxbfgctlVZVmDABIyOz8LqEoJ6ZP4DTyvw==", - "dev": true - }, - "@algolia/logger-console": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/logger-console/-/logger-console-4.17.0.tgz", - "integrity": "sha512-zMPvugQV/gbXUvWBCzihw6m7oxIKp48w37QBIUu/XqQQfxhjoOE9xyfJr1KldUt5FrYOKZJVsJaEjTsu+bIgQg==", - "dev": true, - "requires": { - "@algolia/logger-common": "4.17.0" - } - }, - "@algolia/requester-browser-xhr": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.17.0.tgz", - "integrity": "sha512-aSOX/smauyTkP21Pf52pJ1O2LmNFJ5iHRIzEeTh0mwBeADO4GdG94cAWDILFA9rNblq/nK3EDh3+UyHHjplZ1A==", - "dev": true, - "requires": { - "@algolia/requester-common": "4.17.0" - } - }, - "@algolia/requester-common": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-common/-/requester-common-4.17.0.tgz", - "integrity": "sha512-XJjmWFEUlHu0ijvcHBoixuXfEoiRUdyzQM6YwTuB8usJNIgShua8ouFlRWF8iCeag0vZZiUm4S2WCVBPkdxFgg==", - "dev": true - }, - "@algolia/requester-node-http": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-4.17.0.tgz", - "integrity": "sha512-bpb/wDA1aC6WxxM8v7TsFspB7yBN3nqCGs2H1OADolQR/hiAIjAxusbuMxVbRFOdaUvAIqioIIkWvZdpYNIn8w==", - "dev": true, - "requires": { - "@algolia/requester-common": "4.17.0" - } - }, - "@algolia/transporter": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/@algolia/transporter/-/transporter-4.17.0.tgz", - "integrity": "sha512-6xL6H6fe+Fi0AEP3ziSgC+G04RK37iRb4uUUqVAH9WPYFI8g+LYFq6iv5HS8Cbuc5TTut+Bwj6G+dh/asdb9uA==", - "dev": true, - "requires": { - "@algolia/cache-common": "4.17.0", - "@algolia/logger-common": "4.17.0", - "@algolia/requester-common": "4.17.0" - } - }, - "@babel/parser": { - "version": "7.21.8", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.21.8.tgz", - "integrity": "sha512-6zavDGdzG3gUqAdWvlLFfk+36RilI+Pwyuuh7HItyeScCWP3k6i8vKclAQ0bM/0y/Kz/xiwvxhMv9MgTJP5gmA==", - "dev": true - }, - "@docsearch/css": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/@docsearch/css/-/css-3.3.4.tgz", - "integrity": "sha512-vDwCDoVXDgopw/hvr0zEADew2wWaGP8Qq0Bxhgii1Ewz2t4fQeyJwIRN/mWADeLFYPVkpz8TpEbxya/i6Tm0WA==", - "dev": true - }, - "@docsearch/js": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/@docsearch/js/-/js-3.3.4.tgz", - "integrity": "sha512-Xd2saBziXJ1UuVpcDz94zAFEFAM6ap993agh0za2e3LDZLhaW993b1f9gyUL4e1CZLsR076tztG2un2gVncvpA==", - "dev": true, - "requires": { - "@docsearch/react": "3.3.4", - "preact": "^10.0.0" - } - }, - "@docsearch/react": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/@docsearch/react/-/react-3.3.4.tgz", - "integrity": "sha512-aeOf1WC5zMzBEi2SI6WWznOmIo9rnpN4p7a3zHXxowVciqlI4HsZGtOR9nFOufLeolv7HibwLlaM0oyUqJxasw==", - "dev": true, - "requires": { - "@algolia/autocomplete-core": "1.8.2", - "@algolia/autocomplete-preset-algolia": "1.8.2", - "@docsearch/css": "3.3.4", - "algoliasearch": "^4.0.0" - } - }, - "@esbuild/android-arm": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.17.18.tgz", - "integrity": "sha512-EmwL+vUBZJ7mhFCs5lA4ZimpUH3WMAoqvOIYhVQwdIgSpHC8ImHdsRyhHAVxpDYUSm0lWvd63z0XH1IlImS2Qw==", - "dev": true, - "optional": true - }, - "@esbuild/android-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.17.18.tgz", - "integrity": "sha512-/iq0aK0eeHgSC3z55ucMAHO05OIqmQehiGay8eP5l/5l+iEr4EIbh4/MI8xD9qRFjqzgkc0JkX0LculNC9mXBw==", - "dev": true, - "optional": true - }, - "@esbuild/android-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.17.18.tgz", - "integrity": "sha512-x+0efYNBF3NPW2Xc5bFOSFW7tTXdAcpfEg2nXmxegm4mJuVeS+i109m/7HMiOQ6M12aVGGFlqJX3RhNdYM2lWg==", - "dev": true, - "optional": true - }, - "@esbuild/darwin-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.17.18.tgz", - "integrity": "sha512-6tY+djEAdF48M1ONWnQb1C+6LiXrKjmqjzPNPWXhu/GzOHTHX2nh8Mo2ZAmBFg0kIodHhciEgUBtcYCAIjGbjQ==", - "dev": true, - "optional": true - }, - "@esbuild/darwin-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.17.18.tgz", - "integrity": "sha512-Qq84ykvLvya3dO49wVC9FFCNUfSrQJLbxhoQk/TE1r6MjHo3sFF2tlJCwMjhkBVq3/ahUisj7+EpRSz0/+8+9A==", - "dev": true, - "optional": true - }, - "@esbuild/freebsd-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.17.18.tgz", - "integrity": "sha512-fw/ZfxfAzuHfaQeMDhbzxp9mc+mHn1Y94VDHFHjGvt2Uxl10mT4CDavHm+/L9KG441t1QdABqkVYwakMUeyLRA==", - "dev": true, - "optional": true - }, - "@esbuild/freebsd-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.17.18.tgz", - "integrity": "sha512-FQFbRtTaEi8ZBi/A6kxOC0V0E9B/97vPdYjY9NdawyLd4Qk5VD5g2pbWN2VR1c0xhzcJm74HWpObPszWC+qTew==", - "dev": true, - "optional": true - }, - "@esbuild/linux-arm": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.17.18.tgz", - "integrity": "sha512-jW+UCM40LzHcouIaqv3e/oRs0JM76JfhHjCavPxMUti7VAPh8CaGSlS7cmyrdpzSk7A+8f0hiedHqr/LMnfijg==", - "dev": true, - "optional": true - }, - "@esbuild/linux-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.17.18.tgz", - "integrity": "sha512-R7pZvQZFOY2sxUG8P6A21eq6q+eBv7JPQYIybHVf1XkQYC+lT7nDBdC7wWKTrbvMXKRaGudp/dzZCwL/863mZQ==", - "dev": true, - "optional": true - }, - "@esbuild/linux-ia32": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.17.18.tgz", - "integrity": "sha512-ygIMc3I7wxgXIxk6j3V00VlABIjq260i967Cp9BNAk5pOOpIXmd1RFQJQX9Io7KRsthDrQYrtcx7QCof4o3ZoQ==", - "dev": true, - "optional": true - }, - "@esbuild/linux-loong64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.17.18.tgz", - "integrity": "sha512-bvPG+MyFs5ZlwYclCG1D744oHk1Pv7j8psF5TfYx7otCVmcJsEXgFEhQkbhNW8otDHL1a2KDINW20cfCgnzgMQ==", - "dev": true, - "optional": true - }, - "@esbuild/linux-mips64el": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.17.18.tgz", - "integrity": "sha512-oVqckATOAGuiUOa6wr8TXaVPSa+6IwVJrGidmNZS1cZVx0HqkTMkqFGD2HIx9H1RvOwFeWYdaYbdY6B89KUMxA==", - "dev": true, - "optional": true - }, - "@esbuild/linux-ppc64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.17.18.tgz", - "integrity": "sha512-3dLlQO+b/LnQNxgH4l9rqa2/IwRJVN9u/bK63FhOPB4xqiRqlQAU0qDU3JJuf0BmaH0yytTBdoSBHrb2jqc5qQ==", - "dev": true, - "optional": true - }, - "@esbuild/linux-riscv64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.17.18.tgz", - "integrity": "sha512-/x7leOyDPjZV3TcsdfrSI107zItVnsX1q2nho7hbbQoKnmoeUWjs+08rKKt4AUXju7+3aRZSsKrJtaRmsdL1xA==", - "dev": true, - "optional": true - }, - "@esbuild/linux-s390x": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.17.18.tgz", - "integrity": "sha512-cX0I8Q9xQkL/6F5zWdYmVf5JSQt+ZfZD2bJudZrWD+4mnUvoZ3TDDXtDX2mUaq6upMFv9FlfIh4Gfun0tbGzuw==", - "dev": true, - "optional": true - }, - "@esbuild/linux-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.17.18.tgz", - "integrity": "sha512-66RmRsPlYy4jFl0vG80GcNRdirx4nVWAzJmXkevgphP1qf4dsLQCpSKGM3DUQCojwU1hnepI63gNZdrr02wHUA==", - "dev": true, - "optional": true - }, - "@esbuild/netbsd-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.17.18.tgz", - "integrity": "sha512-95IRY7mI2yrkLlTLb1gpDxdC5WLC5mZDi+kA9dmM5XAGxCME0F8i4bYH4jZreaJ6lIZ0B8hTrweqG1fUyW7jbg==", - "dev": true, - "optional": true - }, - "@esbuild/openbsd-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.17.18.tgz", - "integrity": "sha512-WevVOgcng+8hSZ4Q3BKL3n1xTv5H6Nb53cBrtzzEjDbbnOmucEVcZeGCsCOi9bAOcDYEeBZbD2SJNBxlfP3qiA==", - "dev": true, - "optional": true - }, - "@esbuild/sunos-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.17.18.tgz", - "integrity": "sha512-Rzf4QfQagnwhQXVBS3BYUlxmEbcV7MY+BH5vfDZekU5eYpcffHSyjU8T0xucKVuOcdCsMo+Ur5wmgQJH2GfNrg==", - "dev": true, - "optional": true - }, - "@esbuild/win32-arm64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.17.18.tgz", - "integrity": "sha512-Kb3Ko/KKaWhjeAm2YoT/cNZaHaD1Yk/pa3FTsmqo9uFh1D1Rfco7BBLIPdDOozrObj2sahslFuAQGvWbgWldAg==", - "dev": true, - "optional": true - }, - "@esbuild/win32-ia32": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.17.18.tgz", - "integrity": "sha512-0/xUMIdkVHwkvxfbd5+lfG7mHOf2FRrxNbPiKWg9C4fFrB8H0guClmaM3BFiRUYrznVoyxTIyC/Ou2B7QQSwmw==", - "dev": true, - "optional": true - }, - "@esbuild/win32-x64": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.17.18.tgz", - "integrity": "sha512-qU25Ma1I3NqTSHJUOKi9sAH1/Mzuvlke0ioMJRthLXKm7JiSKVwFghlGbDLOO2sARECGhja4xYfRAZNPAkooYg==", - "dev": true, - "optional": true - }, - "@types/web-bluetooth": { - "version": "0.0.17", - "resolved": "https://registry.npmjs.org/@types/web-bluetooth/-/web-bluetooth-0.0.17.tgz", - "integrity": "sha512-4p9vcSmxAayx72yn70joFoL44c9MO/0+iVEBIQXe3v2h2SiAsEIo/G5v6ObFWvNKRFjbrVadNf9LqEEZeQPzdA==", - "dev": true - }, - "@vitejs/plugin-vue": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/@vitejs/plugin-vue/-/plugin-vue-4.2.1.tgz", - "integrity": "sha512-ZTZjzo7bmxTRTkb8GSTwkPOYDIP7pwuyV+RV53c9PYUouwcbkIZIvWvNWlX2b1dYZqtOv7D6iUAnJLVNGcLrSw==", - "dev": true, - "requires": {} - }, - "@vue/compiler-core": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/compiler-core/-/compiler-core-3.2.47.tgz", - "integrity": "sha512-p4D7FDnQb7+YJmO2iPEv0SQNeNzcbHdGByJDsT4lynf63AFkOTFN07HsiRSvjGo0QrxR/o3d0hUyNCUnBU2Tig==", - "dev": true, - "requires": { - "@babel/parser": "^7.16.4", - "@vue/shared": "3.2.47", - "estree-walker": "^2.0.2", - "source-map": "^0.6.1" - } - }, - "@vue/compiler-dom": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/compiler-dom/-/compiler-dom-3.2.47.tgz", - "integrity": "sha512-dBBnEHEPoftUiS03a4ggEig74J2YBZ2UIeyfpcRM2tavgMWo4bsEfgCGsu+uJIL/vax9S+JztH8NmQerUo7shQ==", - "dev": true, - "requires": { - "@vue/compiler-core": "3.2.47", - "@vue/shared": "3.2.47" - } - }, - "@vue/compiler-sfc": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/compiler-sfc/-/compiler-sfc-3.2.47.tgz", - "integrity": "sha512-rog05W+2IFfxjMcFw10tM9+f7i/+FFpZJJ5XHX72NP9eC2uRD+42M3pYcQqDXVYoj74kHMSEdQ/WmCjt8JFksQ==", - "dev": true, - "requires": { - "@babel/parser": "^7.16.4", - "@vue/compiler-core": "3.2.47", - "@vue/compiler-dom": "3.2.47", - "@vue/compiler-ssr": "3.2.47", - "@vue/reactivity-transform": "3.2.47", - "@vue/shared": "3.2.47", - "estree-walker": "^2.0.2", - "magic-string": "^0.25.7", - "postcss": "^8.1.10", - "source-map": "^0.6.1" - } - }, - "@vue/compiler-ssr": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/compiler-ssr/-/compiler-ssr-3.2.47.tgz", - "integrity": "sha512-wVXC+gszhulcMD8wpxMsqSOpvDZ6xKXSVWkf50Guf/S+28hTAXPDYRTbLQ3EDkOP5Xz/+SY37YiwDquKbJOgZw==", - "dev": true, - "requires": { - "@vue/compiler-dom": "3.2.47", - "@vue/shared": "3.2.47" - } - }, - "@vue/devtools-api": { - "version": "6.5.0", - "resolved": "https://registry.npmjs.org/@vue/devtools-api/-/devtools-api-6.5.0.tgz", - "integrity": "sha512-o9KfBeaBmCKl10usN4crU53fYtC1r7jJwdGKjPT24t348rHxgfpZ0xL3Xm/gLUYnc0oTp8LAmrxOeLyu6tbk2Q==", - "dev": true - }, - "@vue/reactivity": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/reactivity/-/reactivity-3.2.47.tgz", - "integrity": "sha512-7khqQ/75oyyg+N/e+iwV6lpy1f5wq759NdlS1fpAhFXa8VeAIKGgk2E/C4VF59lx5b+Ezs5fpp/5WsRYXQiKxQ==", - "dev": true, - "requires": { - "@vue/shared": "3.2.47" - } - }, - "@vue/reactivity-transform": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/reactivity-transform/-/reactivity-transform-3.2.47.tgz", - "integrity": "sha512-m8lGXw8rdnPVVIdIFhf0LeQ/ixyHkH5plYuS83yop5n7ggVJU+z5v0zecwEnX7fa7HNLBhh2qngJJkxpwEEmYA==", - "dev": true, - "requires": { - "@babel/parser": "^7.16.4", - "@vue/compiler-core": "3.2.47", - "@vue/shared": "3.2.47", - "estree-walker": "^2.0.2", - "magic-string": "^0.25.7" - } - }, - "@vue/runtime-core": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/runtime-core/-/runtime-core-3.2.47.tgz", - "integrity": "sha512-RZxbLQIRB/K0ev0K9FXhNbBzT32H9iRtYbaXb0ZIz2usLms/D55dJR2t6cIEUn6vyhS3ALNvNthI+Q95C+NOpA==", - "dev": true, - "requires": { - "@vue/reactivity": "3.2.47", - "@vue/shared": "3.2.47" - } - }, - "@vue/runtime-dom": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/runtime-dom/-/runtime-dom-3.2.47.tgz", - "integrity": "sha512-ArXrFTjS6TsDei4qwNvgrdmHtD930KgSKGhS5M+j8QxXrDJYLqYw4RRcDy1bz1m1wMmb6j+zGLifdVHtkXA7gA==", - "dev": true, - "requires": { - "@vue/runtime-core": "3.2.47", - "@vue/shared": "3.2.47", - "csstype": "^2.6.8" - } - }, - "@vue/server-renderer": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/server-renderer/-/server-renderer-3.2.47.tgz", - "integrity": "sha512-dN9gc1i8EvmP9RCzvneONXsKfBRgqFeFZLurmHOveL7oH6HiFXJw5OGu294n1nHc/HMgTy6LulU/tv5/A7f/LA==", - "dev": true, - "requires": { - "@vue/compiler-ssr": "3.2.47", - "@vue/shared": "3.2.47" - } - }, - "@vue/shared": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/@vue/shared/-/shared-3.2.47.tgz", - "integrity": "sha512-BHGyyGN3Q97EZx0taMQ+OLNuZcW3d37ZEVmEAyeoA9ERdGvm9Irc/0Fua8SNyOtV1w6BS4q25wbMzJujO9HIfQ==", - "dev": true - }, - "@vueuse/core": { - "version": "10.1.2", - "resolved": "https://registry.npmjs.org/@vueuse/core/-/core-10.1.2.tgz", - "integrity": "sha512-roNn8WuerI56A5uiTyF/TEYX0Y+VKlhZAF94unUfdhbDUI+NfwQMn4FUnUscIRUhv3344qvAghopU4bzLPNFlA==", - "dev": true, - "requires": { - "@types/web-bluetooth": "^0.0.17", - "@vueuse/metadata": "10.1.2", - "@vueuse/shared": "10.1.2", - "vue-demi": ">=0.14.0" - }, - "dependencies": { - "vue-demi": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/vue-demi/-/vue-demi-0.14.0.tgz", - "integrity": "sha512-gt58r2ogsNQeVoQ3EhoUAvUsH9xviydl0dWJj7dabBC/2L4uBId7ujtCwDRD0JhkGsV1i0CtfLAeyYKBht9oWg==", - "dev": true, - "requires": {} - } - } - }, - "@vueuse/metadata": { - "version": "10.1.2", - "resolved": "https://registry.npmjs.org/@vueuse/metadata/-/metadata-10.1.2.tgz", - "integrity": "sha512-3mc5BqN9aU2SqBeBuWE7ne4OtXHoHKggNgxZR2K+zIW4YLsy6xoZ4/9vErQs6tvoKDX6QAqm3lvsrv0mczAwIQ==", - "dev": true - }, - "@vueuse/shared": { - "version": "10.1.2", - "resolved": "https://registry.npmjs.org/@vueuse/shared/-/shared-10.1.2.tgz", - "integrity": "sha512-1uoUTPBlgyscK9v6ScGeVYDDzlPSFXBlxuK7SfrDGyUTBiznb3mNceqhwvZHjtDRELZEN79V5uWPTF1VDV8svA==", - "dev": true, - "requires": { - "vue-demi": ">=0.14.0" - }, - "dependencies": { - "vue-demi": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/vue-demi/-/vue-demi-0.14.0.tgz", - "integrity": "sha512-gt58r2ogsNQeVoQ3EhoUAvUsH9xviydl0dWJj7dabBC/2L4uBId7ujtCwDRD0JhkGsV1i0CtfLAeyYKBht9oWg==", - "dev": true, - "requires": {} - } - } - }, - "algoliasearch": { - "version": "4.17.0", - "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-4.17.0.tgz", - "integrity": "sha512-JMRh2Mw6sEnVMiz6+APsi7lx9a2jiDFF+WUtANaUVCv6uSU9UOLdo5h9K3pdP6frRRybaM2fX8b1u0nqICS9aA==", - "dev": true, - "requires": { - "@algolia/cache-browser-local-storage": "4.17.0", - "@algolia/cache-common": "4.17.0", - "@algolia/cache-in-memory": "4.17.0", - "@algolia/client-account": "4.17.0", - "@algolia/client-analytics": "4.17.0", - "@algolia/client-common": "4.17.0", - "@algolia/client-personalization": "4.17.0", - "@algolia/client-search": "4.17.0", - "@algolia/logger-common": "4.17.0", - "@algolia/logger-console": "4.17.0", - "@algolia/requester-browser-xhr": "4.17.0", - "@algolia/requester-common": "4.17.0", - "@algolia/requester-node-http": "4.17.0", - "@algolia/transporter": "4.17.0" - } - }, - "ansi-sequence-parser": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.0.tgz", - "integrity": "sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ==", - "dev": true - }, - "body-scroll-lock": { - "version": "4.0.0-beta.0", - "resolved": "https://registry.npmjs.org/body-scroll-lock/-/body-scroll-lock-4.0.0-beta.0.tgz", - "integrity": "sha512-a7tP5+0Mw3YlUJcGAKUqIBkYYGlYxk2fnCasq/FUph1hadxlTRjF+gAcZksxANnaMnALjxEddmSi/H3OR8ugcQ==", - "dev": true - }, - "csstype": { - "version": "2.6.21", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-2.6.21.tgz", - "integrity": "sha512-Z1PhmomIfypOpoMjRQB70jfvy/wxT50qW08YXO5lMIJkrdq4yOTR+AW7FqutScmB9NkLwxo+jU+kZLbofZZq/w==", - "dev": true - }, - "esbuild": { - "version": "0.17.18", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.17.18.tgz", - "integrity": "sha512-z1lix43jBs6UKjcZVKOw2xx69ffE2aG0PygLL5qJ9OS/gy0Ewd1gW/PUQIOIQGXBHWNywSc0floSKoMFF8aK2w==", - "dev": true, - "requires": { - "@esbuild/android-arm": "0.17.18", - "@esbuild/android-arm64": "0.17.18", - "@esbuild/android-x64": "0.17.18", - "@esbuild/darwin-arm64": "0.17.18", - "@esbuild/darwin-x64": "0.17.18", - "@esbuild/freebsd-arm64": "0.17.18", - "@esbuild/freebsd-x64": "0.17.18", - "@esbuild/linux-arm": "0.17.18", - "@esbuild/linux-arm64": "0.17.18", - "@esbuild/linux-ia32": "0.17.18", - "@esbuild/linux-loong64": "0.17.18", - "@esbuild/linux-mips64el": "0.17.18", - "@esbuild/linux-ppc64": "0.17.18", - "@esbuild/linux-riscv64": "0.17.18", - "@esbuild/linux-s390x": "0.17.18", - "@esbuild/linux-x64": "0.17.18", - "@esbuild/netbsd-x64": "0.17.18", - "@esbuild/openbsd-x64": "0.17.18", - "@esbuild/sunos-x64": "0.17.18", - "@esbuild/win32-arm64": "0.17.18", - "@esbuild/win32-ia32": "0.17.18", - "@esbuild/win32-x64": "0.17.18" - } - }, - "estree-walker": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", - "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", - "dev": true - }, - "fsevents": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz", - "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==", - "dev": true, - "optional": true - }, - "jsonc-parser": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz", - "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", - "dev": true - }, - "magic-string": { - "version": "0.25.9", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", - "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", - "dev": true, - "requires": { - "sourcemap-codec": "^1.4.8" - } - }, - "mark.js": { - "version": "8.11.1", - "resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz", - "integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==", - "dev": true - }, - "minisearch": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/minisearch/-/minisearch-6.0.1.tgz", - "integrity": "sha512-Ly1w0nHKnlhAAh6/BF/+9NgzXfoJxaJ8nhopFhQ3NcvFJrFIL+iCg9gw9e9UMBD+XIsp/RyznJ/o5UIe5Kw+kg==", - "dev": true - }, - "nanoid": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", - "integrity": "sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==", - "dev": true - }, - "picocolors": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", - "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", - "dev": true - }, - "postcss": { - "version": "8.4.23", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.23.tgz", - "integrity": "sha512-bQ3qMcpF6A/YjR55xtoTr0jGOlnPOKAIMdOWiv0EIT6HVPEaJiJB4NLljSbiHoC2RX7DN5Uvjtpbg1NPdwv1oA==", - "dev": true, - "requires": { - "nanoid": "^3.3.6", - "picocolors": "^1.0.0", - "source-map-js": "^1.0.2" - } - }, - "preact": { - "version": "10.13.2", - "resolved": "https://registry.npmjs.org/preact/-/preact-10.13.2.tgz", - "integrity": "sha512-q44QFLhOhty2Bd0Y46fnYW0gD/cbVM9dUVtNTDKPcdXSMA7jfY+Jpd6rk3GB0lcQss0z5s/6CmVP0Z/hV+g6pw==", - "dev": true - }, - "rollup": { - "version": "3.21.3", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.21.3.tgz", - "integrity": "sha512-VnPfEG51nIv2xPLnZaekkuN06q9ZbnyDcLkaBdJa/W7UddyhOfMP2yOPziYQfeY7k++fZM8FdQIummFN5y14kA==", - "dev": true, - "requires": { - "fsevents": "~2.3.2" - } - }, - "shiki": { - "version": "0.14.2", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.2.tgz", - "integrity": "sha512-ltSZlSLOuSY0M0Y75KA+ieRaZ0Trf5Wl3gutE7jzLuIcWxLp5i/uEnLoQWNvgKXQ5OMpGkJnVMRLAuzjc0LJ2A==", - "dev": true, - "requires": { - "ansi-sequence-parser": "^1.1.0", - "jsonc-parser": "^3.2.0", - "vscode-oniguruma": "^1.7.0", - "vscode-textmate": "^8.0.0" - } - }, - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true - }, - "source-map-js": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz", - "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==", - "dev": true - }, - "sourcemap-codec": { - "version": "1.4.8", - "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", - "integrity": "sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==", - "dev": true - }, - "vite": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-4.3.4.tgz", - "integrity": "sha512-f90aqGBoxSFxWph2b39ae2uHAxm5jFBBdnfueNxZAT1FTpM13ccFQExCaKbR2xFW5atowjleRniQ7onjJ22QEg==", - "dev": true, - "requires": { - "esbuild": "^0.17.5", - "fsevents": "~2.3.2", - "postcss": "^8.4.23", - "rollup": "^3.21.0" - } - }, - "vitepress": { - "version": "1.0.0-alpha.75", - "resolved": "https://registry.npmjs.org/vitepress/-/vitepress-1.0.0-alpha.75.tgz", - "integrity": "sha512-twpPZ/6UnDR8X0Nmj767KwKhXlTQQM9V/J1i2BP9ryO29/w4hpxBfEum6nvfpNhJ4H3h+cIhwzAK/e9crZ6HEQ==", - "dev": true, - "requires": { - "@docsearch/css": "^3.3.4", - "@docsearch/js": "^3.3.4", - "@vitejs/plugin-vue": "^4.2.1", - "@vue/devtools-api": "^6.5.0", - "@vueuse/core": "^10.1.0", - "body-scroll-lock": "4.0.0-beta.0", - "mark.js": "8.11.1", - "minisearch": "^6.0.1", - "shiki": "^0.14.2", - "vite": "^4.3.3", - "vue": "^3.2.47" - } - }, - "vscode-oniguruma": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", - "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", - "dev": true - }, - "vscode-textmate": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", - "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", - "dev": true - }, - "vue": { - "version": "3.2.47", - "resolved": "https://registry.npmjs.org/vue/-/vue-3.2.47.tgz", - "integrity": "sha512-60188y/9Dc9WVrAZeUVSDxRQOZ+z+y5nO2ts9jWXSTkMvayiWxCWOWtBQoYjLeccfXkiiPZWAHcV+WTPhkqJHQ==", - "dev": true, - "requires": { - "@vue/compiler-dom": "3.2.47", - "@vue/compiler-sfc": "3.2.47", - "@vue/runtime-dom": "3.2.47", - "@vue/server-renderer": "3.2.47", - "@vue/shared": "3.2.47" - } - } - } -} diff --git a/apps/zhi-docs-vitepress/package.json b/apps/zhi-docs-vitepress/package.json deleted file mode 100644 index b5cdbcd8..00000000 --- a/apps/zhi-docs-vitepress/package.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "name": "zhi-docs-vitepress", - "version": "1.0.0", - "scripts": { - "dev": "pnpm predocs:dev && pnpm docs:dev", - "build": "pnpm predocs:dev && pnpm docs:build", - "publish-typedoc": "typedoc --options typedoc.json", - "predocs:dev": "pnpm publish-typedoc", - "docs:dev": "vitepress dev docs", - "docs:build": "vitepress build docs", - "docs:preview": "vitepress preview docs" - }, - "author": "Thomas Grey", - "license": "MIT", - "devDependencies": { - "typedoc": "0.24.7", - "typedoc-plugin-frontmatter": "^0.0.2", - "typedoc-plugin-markdown": "workspace:*", - "typedoc-vitepress-theme": "workspace:*", - "vitepress": "^1.0.0-alpha.75" - } -} diff --git a/apps/zhi-docs-vitepress/tsconfig.json b/apps/zhi-docs-vitepress/tsconfig.json deleted file mode 100644 index ccb37510..00000000 --- a/apps/zhi-docs-vitepress/tsconfig.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "compilerOptions": { - "target": "ES2020", - "useDefineForClassFields": true, - "module": "ESNext", - "lib": ["ES2020", "DOM", "DOM.Iterable"], - "skipLibCheck": true, - "esModuleInterop": true, - - /* Bundler mode */ - "moduleResolution": "Node", - // "allowImportingTsExtensions": true, - "allowSyntheticDefaultImports": true, - "resolveJsonModule": true, - "isolatedModules": true, - "noEmit": true, - "jsx": "preserve", - - /* Linting */ - "strict": true, - "noUnusedLocals": true, - "noUnusedParameters": true, - "noFallthroughCasesInSwitch": true, - - "types": ["node", "vite/client"] - }, - "include": [ - "./docs/.vitepress/config.ts", - "../../libs/zhi-device/src/**/*.ts", - "../../libs/zhi-env/src/**/*.ts", - "../../libs/zhi-log/src/**/*.ts", - "../../libs/zhi-common/src/**/*.ts", - "../../libs/zhi-electron/src/**/*.ts", - "../../libs/zhi-blog-api/src/**/*.ts", - "../../libs/zhi-siyuan-api/src/**/*.ts" - ], - "exclude": ["./node_modules"] -} \ No newline at end of file diff --git a/apps/zhi-docs-vitepress/typedoc.json b/apps/zhi-docs-vitepress/typedoc.json deleted file mode 100644 index 9e615fb8..00000000 --- a/apps/zhi-docs-vitepress/typedoc.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "plugin": [ - "typedoc-plugin-frontmatter", - "./node_modules/typedoc-plugin-markdown/dist", - "./node_modules/typedoc-vitepress-theme/dist" - ], - "entryPoints": [ - "../../libs/zhi-device/src/index.ts", - "../../libs/zhi-env/src/index.ts", - "../../libs/zhi-log/src/index.ts", - "../../libs/zhi-common/src/index.ts", - "../../libs/zhi-electron/src/index.ts", - "../../libs/zhi-blog-api/src/index.ts", - "../../libs/zhi-siyuan-api/src/index.ts" - ], - "tsconfig": "./tsconfig.json", - "frontmatterTags": ["author", "description", "outline"] -} \ No newline at end of file diff --git a/tools/api-docs/api-extractor-base.json b/tools/api-docs/api-extractor-base.json deleted file mode 100644 index a83852ca..00000000 --- a/tools/api-docs/api-extractor-base.json +++ /dev/null @@ -1,435 +0,0 @@ -/** - * Config file for API Extractor. For more info, please visit: https://api-extractor.com - */ -{ - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - - /** - * Optionally specifies another JSON config file that this file extends from. This provides a way for - * standard settings to be shared across multiple projects. - * - * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains - * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be - * resolved using NodeJS require(). - * - * SUPPORTED TOKENS: none - * DEFAULT VALUE: "" - */ - // "extends": "./shared/api-extractor-base.json" - // "extends": "my-package/include/api-extractor-base.json" - - /** - * Determines the "" token that can be used with other config file settings. The project folder - * typically contains the tsconfig.json and package.json config files, but the path is user-defined. - * - * The path is resolved relative to the folder of the config file that contains the setting. - * - * The default value for "projectFolder" is the token "", which means the folder is determined by traversing - * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder - * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error - * will be reported. - * - * SUPPORTED TOKENS: - * DEFAULT VALUE: "" - */ - // "projectFolder": "..", - - /** - * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor - * analyzes the symbols exported by this module. - * - * The file extension must be ".d.ts" and not ".ts". - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - */ - "mainEntryPointFilePath": "/lib/index.d.ts", - - /** - * A list of NPM package names whose exports should be treated as part of this package. - * - * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1", - * and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part - * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly - * imports library2. To avoid this, we can specify: - * - * "bundledPackages": [ "library2" ], - * - * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been - * local files for library1. - */ - "bundledPackages": [], - - /** - * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files - * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead. - * To use the OS's default newline kind, specify "os". - * - * DEFAULT VALUE: "crlf" - */ - // "newlineKind": "crlf", - - /** - * Set to true when invoking API Extractor's test harness. When `testMode` is true, the `toolVersion` field in the - * .api.json file is assigned an empty string to prevent spurious diffs in output files tracked for tests. - * - * DEFAULT VALUE: "false" - */ - // "testMode": false, - - /** - * Specifies how API Extractor sorts members of an enum when generating the .api.json file. By default, the output - * files will be sorted alphabetically, which is "by-name". To keep the ordering in the source code, specify - * "preserve". - * - * DEFAULT VALUE: "by-name" - */ - // "enumMemberOrder": "by-name", - - /** - * Determines how the TypeScript compiler engine will be invoked by API Extractor. - */ - "compiler": { - /** - * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * Note: This setting will be ignored if "overrideTsconfig" is used. - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/tsconfig.json" - */ - // "tsconfigFilePath": "/tsconfig.json", - /** - * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. - * The object must conform to the TypeScript tsconfig schema: - * - * http://json.schemastore.org/tsconfig - * - * If omitted, then the tsconfig.json file will be read from the "projectFolder". - * - * DEFAULT VALUE: no overrideTsconfig section - */ - // "overrideTsconfig": { - // . . . - // } - /** - * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended - * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when - * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses - * for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. - * - * DEFAULT VALUE: false - */ - // "skipLibCheck": true, - }, - - /** - * Configures how the API report file (*.api.md) will be generated. - */ - "apiReport": { - /** - * (REQUIRED) Whether to generate an API report. - */ - "enabled": true, - - /** - * For a single project, it's fine to keep the report in the default location "/etc/". Whereas if you - * work in a monorepo with many projects, you may prefer to have all the API report files written to a central - * location such as common/reviews/api used by the rushstack repo where API Extractor is developed. - */ - "reportFolder": "/etc/" - - /** - * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce - * a full file path. - * - * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/". - * - * SUPPORTED TOKENS: , - * DEFAULT VALUE: ".api.md" - */ - // "reportFileName": ".api.md", - - /** - * Specifies the folder where the API report file is written. The file name portion is determined by - * the "reportFileName" setting. - * - * The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy, - * e.g. for an API review. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/temp/" - */ - // "reportFolder": "/temp/", - - /** - * Specifies the folder where the temporary report file is written. The file name portion is determined by - * the "reportFileName" setting. - * - * After the temporary file is written to disk, it is compared with the file in the "reportFolder". - * If they are different, a production build will fail. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/temp/" - */ - // "reportTempFolder": "/temp/", - - /** - * Whether "forgotten exports" should be included in the API report file. Forgotten exports are declarations - * flagged with `ae-forgotten-export` warnings. See https://api-extractor.com/pages/messages/ae-forgotten-export/ to - * learn more. - * - * DEFAULT VALUE: "false" - */ - // "includeForgottenExports": false - }, - - /** - * Configures how the doc model file (*.api.json) will be generated. - */ - "docModel": { - /** - * (REQUIRED) Whether to generate a doc model file. - */ - "enabled": true - - /** - * The output path for the doc model file. The file extension should be ".api.json". - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/temp/.api.json" - */ - // "apiJsonFilePath": "/temp/.api.json", - - /** - * Whether "forgotten exports" should be included in the doc model file. Forgotten exports are declarations - * flagged with `ae-forgotten-export` warnings. See https://api-extractor.com/pages/messages/ae-forgotten-export/ to - * learn more. - * - * DEFAULT VALUE: "false" - */ - // "includeForgottenExports": false, - - /** - * The base URL where the project's source code can be viewed on a website such as GitHub or - * Azure DevOps. This URL path corresponds to the `` path on disk. - * - * This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items. - * For example, if the `projectFolderUrl` is "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor" and an API - * item's file path is "api/ExtractorConfig.ts", the full URL file path would be - * "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js". - * - * Can be omitted if you don't need source code links in your API documentation reference. - * - * SUPPORTED TOKENS: none - * DEFAULT VALUE: "" - */ - // "projectFolderUrl": "http://github.com/path/to/your/projectFolder" - }, - - /** - * Configures how the .d.ts rollup file will be generated. - */ - "dtsRollup": { - /** - * (REQUIRED) Whether to generate the .d.ts rollup file. - */ - "enabled": true, - - /** - * Specifies the output path for a .d.ts rollup file to be generated without any trimming. - * This file will include all declarations that are exported by the main entry point. - * - * If the path is an empty string, then this file will not be written. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/dist/.d.ts" - */ - "untrimmedFilePath": "/dist/index.d.ts" - // "untrimmedFilePath": "/dist/.d.ts", - - /** - * Specifies the output path for a .d.ts rollup file to be generated with trimming for an "alpha" release. - * This file will include only declarations that are marked as "@public", "@beta", or "@alpha". - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "" - */ - // "alphaTrimmedFilePath": "/dist/-alpha.d.ts", - - /** - * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. - * This file will include only declarations that are marked as "@public" or "@beta". - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "" - */ - // "betaTrimmedFilePath": "/dist/-beta.d.ts", - - /** - * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. - * This file will include only declarations that are marked as "@public". - * - * If the path is an empty string, then this file will not be written. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "" - */ - // "publicTrimmedFilePath": "/dist/-public.d.ts", - - /** - * When a declaration is trimmed, by default it will be replaced by a code comment such as - * "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the - * declaration completely. - * - * DEFAULT VALUE: false - */ - // "omitTrimmingComments": true - }, - - /** - * Configures how the tsdoc-metadata.json file will be generated. - */ - "tsdocMetadata": { - /** - * Whether to generate the tsdoc-metadata.json file. - * - * DEFAULT VALUE: true - */ - // "enabled": true, - /** - * Specifies where the TSDoc metadata file should be written. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * The default value is "", which causes the path to be automatically inferred from the "tsdocMetadata", - * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup - * falls back to "tsdoc-metadata.json" in the package folder. - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "" - */ - // "tsdocMetadataFilePath": "/dist/tsdoc-metadata.json" - }, - - /** - * Configures how API Extractor reports error and warning messages produced during analysis. - * - * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages. - */ - "messages": { - /** - * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing - * the input .d.ts files. - * - * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551" - * - * DEFAULT VALUE: A single "default" entry with logLevel=warning. - */ - "compilerMessageReporting": { - /** - * Configures the default routing for messages that don't match an explicit rule in this table. - */ - "default": { - /** - * Specifies whether the message should be written to the the tool's output log. Note that - * the "addToApiReportFile" property may supersede this option. - * - * Possible values: "error", "warning", "none" - * - * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail - * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes - * the "--local" option), the warning is displayed but the build will not fail. - * - * DEFAULT VALUE: "warning" - */ - "logLevel": "warning" - - /** - * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), - * then the message will be written inside that file; otherwise, the message is instead logged according to - * the "logLevel" option. - * - * DEFAULT VALUE: false - */ - // "addToApiReportFile": false - } - - // "TS2551": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - }, - - /** - * Configures handling of messages reported by API Extractor during its analysis. - * - * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag" - * - * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings - */ - "extractorMessageReporting": { - "default": { - "logLevel": "warning" - // "addToApiReportFile": false - } - - // "ae-extra-release-tag": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - }, - - /** - * Configures handling of messages reported by the TSDoc parser when analyzing code comments. - * - * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text" - * - * DEFAULT VALUE: A single "default" entry with logLevel=warning. - */ - "tsdocMessageReporting": { - "default": { - "logLevel": "warning" - // "addToApiReportFile": false - } - - // "tsdoc-link-tag-unescaped-text": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - } - } -} diff --git a/tools/api-docs/api-extractor.example.json b/tools/api-docs/api-extractor.example.json deleted file mode 100644 index 34cc2c8c..00000000 --- a/tools/api-docs/api-extractor.example.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "api-docs/api-extractor-base.json", - - "apiReport": { - "enabled": true, - "reportFolder": "../../reports/api/" - } -} \ No newline at end of file diff --git a/tools/api-docs/package.json b/tools/api-docs/package.json deleted file mode 100644 index 3f375496..00000000 --- a/tools/api-docs/package.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "name": "@terwer/api-docs", - "version": "1.0.0", - "license": "GPL", - "devDependencies": { - "@microsoft/api-documenter": "^7.21.7", - "@microsoft/api-extractor": "^7.34.4" - }, - "publishConfig": { - "access": "public" - } -} \ No newline at end of file diff --git a/tools/api-docs/tsdoc.base.json b/tools/api-docs/tsdoc.base.json deleted file mode 100644 index 0aed6f29..00000000 --- a/tools/api-docs/tsdoc.base.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - - // Include the definitions that are required for API Extractor - "extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"], - - // noStandardTags: false, - - "tagDefinitions": [ - // Define a custom tag and specify how it should be parsed - { - "tagName": "@author", - "syntaxKind": "block", - "allowMultiple": false - }, - { - "tagName": "@since", - "syntaxKind": "block", - "allowMultiple": false - }, - { - "tagName": "@private", - "syntaxKind": "block", - "allowMultiple": false - }, - { - "tagName": "@protected", - "syntaxKind": "block", - "allowMultiple": false - }, - { - "tagName": "@version", - "syntaxKind": "block", - "allowMultiple": false - } - ], - - "supportForTags": { - // Indicate that the custom tag is supported by your tooling. (Without this, warnings may - // be reported saying that the tag is unsupported.) - "@author": true, - "@since": true, - "@private": true, - "@protected": true - } -} diff --git a/tools/typedoc-plugin-markdown/.markdownlint.yaml b/tools/typedoc-plugin-markdown/.markdownlint.yaml deleted file mode 100644 index 28ed03d6..00000000 --- a/tools/typedoc-plugin-markdown/.markdownlint.yaml +++ /dev/null @@ -1,18 +0,0 @@ -# MD013/line-length - Line length -MD013: false - -# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content -MD024: false - -# MD028 - Blank line inside blockquote - -MD028: false - -# MD033/no-inline-html - Inline HTML -MD033: false - -# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading -MD041: false - -# MD052/reference-links-images - Reference links and images should use a label that is defined -MD052: false diff --git a/tools/typedoc-plugin-markdown/CHANGELOG.md b/tools/typedoc-plugin-markdown/CHANGELOG.md deleted file mode 100644 index 9d7a381e..00000000 --- a/tools/typedoc-plugin-markdown/CHANGELOG.md +++ /dev/null @@ -1,373 +0,0 @@ -# Changelog - -## 4.0.0-next.11 (2023-05-13) - -### Patch Changes - -- Simplified fileoutput options - replaced kindsWithOwnFile option with an easier to understand `outputFileStrategy` option (see docs) -- Extract frontmatter logic into seperate TypeDoc plugin -- Fix fileoutput for 'packages' entryPointStrategy -- Tweaked header/breadcrumbs -- Escape angle brackets in comment blocks unless inside backticks ([#276](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/276)) -- UI tweaks to properties display - -## 4.0.0-next.10 - -### Patch Changes - -- Fix pipes not being escaped correctly with union types in properties table -- Exposed navigation object to renderer -- General UI updates and fixes - -## 4.0.0-next.9 - -### Patch Changes - -- Discover prettier config files - -## 4.0.0-next.8 - -### Patch Changes - -- Added `numberPrefixOutput` and `hideKindTag` options -- Support `includeVersion` -- Decoupled renderer methods -- Further refactoring and fixes - -## 4.0.0-next.7 - -### Patch Changes - -- Added `indentifiersAsCodeBlocks`, `propertiesFormat`, `typeDeclarationFormat`, `enumMembersFormat` options. -- Renamed `reflectionsWithOwnFile`=>`kindsWithOwnFile` and `groupByReflections`=>`groupByKinds`. -- General ui tweaks and fixes - -## 4.0.0-next.6 - -### Patch Changes - -- Refactored fileoutput options (renamed symbolsWithOwnFile=>reflectionsWithOwnFile, groupBySymbols=>groupByReflections) - -## 4.0.0-next.5 - -### Patch Changes - -- Fix incorrect heading levels -- Slugify output filenames -- Expose `groupBySymbols` option - -## 4.0.0-next.4 - -### Patch Changes - -- Mark final default parameters as optional ([#396](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/396)) - -- Run prettier on output files ([#398](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/398)) - -- Replace new lines in tables with `
` ([#331](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/331)) - -- TypdeDoc 0.24 compatibility fixes. - -- Escape curly braces in type declarations - -## 4.0.0-next.3 - -### Patch Changes - -- Expose referenced type links on declaration -- UI fixes - -## 4.0.0-next.2 - -### Patch Changes - -- Fix optional declarations in code blocks -- Improve hierarchy output - -## 4.0.0-next.1 - -### Minor Changes - -- Expose Frontmatter options ([#384](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/384)), ([#360](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/360)) -- Convert comment `@tags` to headings -- Export files following module structure as default -- UI improvemements - -### Patch Changes - -- Respect monorepo `readmeFile` configuration ([#383](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/383)) -- Fix incorrect heading levels on project reflections - -## 4.0.0-next.0 - -### Major Changes - -Initial release of next version. In summary includes: - -- Removal of handlebars. -- MDX2 support as standard ([(#305)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/305), [(#252)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/252)). -- Exposes additional output file options ([(#353)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/353), [(#338)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/338), [(#328)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/328), [(#307)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/307)). -- Several UI improvements. - -## [3.13.4](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.3...typedoc-plugin-markdown@3.13.4) (2022-07-20) - -### Fixes - -- Support @typeParam comments [(#326)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/326) - -## [3.13.3](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.2...typedoc-plugin-markdown@3.13.3) (2022-07-05) - -### Fixes - -- Remove extraneous whitespace in tag description [(#324)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/324) - -## [3.13.2](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.1...typedoc-plugin-markdown@3.13.2) (2022-06-30) - -### Fixes - -- Correctly display accessors in type declaration [(#320)](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/c7fd71aa13159ee729526bdd9b7688169752da64) -- Add new line after tags [(#324)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/324) -- Expose values to enums [(#323)](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/323) - -## [3.13.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.0...typedoc-plugin-markdown@3.13.1) (2022-06-28) - -**Note:** Version bump only for package typedoc-plugin-markdown - -# [3.13.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.12.1...typedoc-plugin-markdown@3.13.0) (2022-06-27) - -### Features - -- TypeDoc 0.23 compatibility fixes ([f39318e](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f39318e1a58943170282b45a6d6cd0545a80cd4a)) - -## [3.12.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.12.0...typedoc-plugin-markdown@3.12.1) (2022-04-21) - -### Bug Fixes - -- Handle non-unique anchor ids (update) ([#303](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/303)) ([2deb7b7](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/2deb7b734e6ec837aa403f4a70e01e56ccc47cc9)) - -# [3.12.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.14...typedoc-plugin-markdown@3.12.0) (2022-04-09) - -### Bug Fixes - -- Handle non-unique anchor ids ([#303](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/303)) ([787748f](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/787748f274d2def8fa4a1e08795a398c5a771f4f)) - -### Features - -- Expose `preserveAnchorCasing` option ([#301](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/301)) ([f51ff45](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f51ff45d20758a19c851c37561dd2c07e80f0c23)) - -## [3.11.14](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.13...typedoc-plugin-markdown@3.11.14) (2022-02-14) - -### Bug Fixes - -- wrap index signature output within back ticks ([#292](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/292)) ([2226322](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/22263229bf2fc9bab4fe61f03cd915f63f8e1aa4)) - -## [3.11.13](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.12...typedoc-plugin-markdown@3.11.13) (2022-02-05) - -### Bug Fixes - -- Escape pipes in comments and expand object type in props table ([#286](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/286)) ([b87c250](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/b87c2505a57035d190b8694268e658f1cd1bb426)) - -## [3.11.12](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.11...typedoc-plugin-markdown@3.11.12) (2022-01-18) - -### Bug Fixes - -- Fixed external resolution reference ([#283](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/283)) ([ba935c9](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/ba935c9eff51f5ac61a96299c437263daf07d87a)) - -## [3.11.11](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.10...typedoc-plugin-markdown@3.11.11) (2022-01-09) - -### Bug Fixes - -- Add comments for function type properties ([#281](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/281)) ([d3441f2](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/d3441f2ab12e7a025cad0fc1d08a42f8d8bc0b91)) - -## [3.11.10](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.9...typedoc-plugin-markdown@3.11.10) (2022-01-09) - -### Bug Fixes - -- Add comments for function type properties ([#281](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/281)) ([c38a095](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/c38a095ea5b8d76d1c1657a244cc0d1c33361065)) -- Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45)) - -## [3.11.9](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.8...typedoc-plugin-markdown@3.11.9) (2022-01-05) - -### Bug Fixes - -- Expose missing namedAnchors option (regression) ([#277](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/277)) ([5353334](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/53533342d0b34230ae344dbe4bf8563e4899da5b)) -- Watch mode compatibility ([#279](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/279)) ([da65f74](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/da65f741c38ca6a5c2fefc58c4d4fd0cbc9a6d25)) - -## [3.11.8](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.7...typedoc-plugin-markdown@3.11.8) (2021-12-17) - -### Bug Fixes - -- Fixed linked resolution ([#274](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/274)) - -## [3.11.7](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.6...typedoc-plugin-markdown@3.11.7) (2021-11-20) - -### Bug Fixes - -- Expand generic object ([#268](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/268)) ([5029a85](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5029a8519ad840675eb3772d6c6c154228e5f4b0)) - -## [3.11.6](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.5...typedoc-plugin-markdown@3.11.6) (2021-11-14) - -### Bug Fixes - -- Catch all external references ([003cb96](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/003cb96952bbf1c7b1a651fe96903f57aca3c020)) -- Fix type params with default values in params table ([7d73eff](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/7d73eff18cb919a9c1069977ebece3844528dfed)) - -## [3.11.5](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.4...typedoc-plugin-markdown@3.11.5) (2021-11-12) - -### Bug Fixes - -- Expose 'includes' and 'media' options (regression) ([#264](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/264)) ([435e0d2](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/435e0d2a3cbedbf3d935059f3f07ab3cd23d4470)) - -## [3.11.4](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.3...typedoc-plugin-markdown@3.11.4) (2021-11-12) - -### Bug Fixes - -- Added support for third party symbols ([#263](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/263)) ([e5a40d5](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/e5a40d58050cad370c82fc5ef897f8d7268e1d13)) - -## [3.11.3](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.2...typedoc-plugin-markdown@3.11.3) (2021-10-05) - -### Bug Fixes - -- correctly render reference ([#254](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/254)) ([32ce13a](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/32ce13a8f4336279ab60b1992b59ef848624560c)) - -## [3.11.2](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.1...typedoc-plugin-markdown@3.11.2) (2021-09-25) - -### Bug Fixes - -- Remove leading underscore from file names ([#248](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/248)) ([bb5e4e3](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/bb5e4e32437c367e03db6b6d4b83487b15698c6b)) - -## [3.11.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.11.0...typedoc-plugin-markdown@3.11.1) (2021-09-23) - -### Bug Fixes - -- Fix `allReflectionsHaveOwnDocument` option ([64376e9](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/64376e9bd3beb2e941d0640408ace04786db4c7e)) -- Properly escape chars inside anchors ([d4e5b1d](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/d4e5b1db4dcbc21601cc3a7b6122810f9cbb9152)) - -# [3.11.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.10.4...typedoc-plugin-markdown@3.11.0) (2021-09-14) - -### Features - -- TypeDoc 0.22 compatibility fixes ([#249](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/249)) ([963250c](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/963250cbe0b12bc3f413b5138d6d4e33ad2a6353)) - -## [3.10.4](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.10.3...typedoc-plugin-markdown@3.10.4) (2021-07-20) - -### Bug Fixes - -- Fix anonymous function types in params table ([0047faf](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/0047faf1d3e2ec91752cef0603f2838ce1e70be9)) - -## [3.10.3](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.10.2...typedoc-plugin-markdown@3.10.3) (2021-07-12) - -### Bug Fixes - -- Handle TypeDoc 0.21.3 options breaking change ([2d0e7b5](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/2d0e7b507c79d26c762a763bab779796520cd7b4)) - -## [3.10.2](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.10.1...typedoc-plugin-markdown@3.10.2) (2021-06-24) - -### Bug Fixes - -- Fix string escape inside backticks ([3b8ab18](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/3b8ab18adda9023f79aaa6d1e377d710d8a09f38)) - -## [3.10.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.10.0...typedoc-plugin-markdown@3.10.1) (2021-06-23) - -### Bug Fixes - -- Improve type params table readability ([52038e2](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/52038e228d0dac557b9c972ab6999389d1d6132a)) -- Use backticks for generics and refernce types to improve consistency ([#239](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/239)) ([1b3395f](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/1b3395f27c7d03d8d1509b9d97dcd06830ff17f5)) - -# [3.10.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.9.0...typedoc-plugin-markdown@3.10.0) (2021-06-18) - -### Features - -- TypeDoc 0.21 compatibility ([fa5e913](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/fa5e913ef238c92817761218aa77022bff8d999a)) - -# [3.9.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.8.2...typedoc-plugin-markdown@3.9.0) (2021-06-01) - -### Features - -- UI fixes and readability enhancements ([#230](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/230)) ([f4329a9](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f4329a9c989201d69b0e54497eba4f3e6c095abc)) - -## [3.8.2](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.8.1...typedoc-plugin-markdown@3.8.2) (2021-05-26) - -### Bug Fixes - -- Escape leading quote in front-matter string ([#228](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/228)) ([ec38cbc](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/ec38cbc550de9e6ee319129fda96c17ab342bae5)) - -## [3.8.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.8.0...typedoc-plugin-markdown@3.8.1) (2021-05-11) - -### Bug Fixes - -- Escape double quotes inside Front Matter yaml string ([8ce2f2b](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/8ce2f2be03be6cd8d730786d48b5cd484b82ec4e)) -- Fix duplicate source blocks ([616ca4e](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/616ca4e0e28431f4183c60b54fa9682c391dffe9)) - -# [3.8.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.7.2...typedoc-plugin-markdown@3.8.0) (2021-05-05) - -### Bug Fixes - -- Add space between 'Const' and signature name ([#220](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/220)) ([9400803](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/9400803a7dd0809d92c01d654e3fa75a01cb747e)) - -### Features - -- Enforce markdownlint standards ([#219](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/219)) ([76a90bb](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/76a90bb052fa289d5b234081e45b9b40e3c7649c)) -- Improve heading structure with disabled inline toc ([#222](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/222)) ([2e898ac](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/2e898ac1ec7b00a610da7d57d90a155f649d64a7)) - -## [3.7.2](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.7.1...typedoc-plugin-markdown@3.7.2) (2021-04-25) - -### Bug Fixes - -- Escape inherited types ([#215](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/215)) ([34c5e7b](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/34c5e7b9265a1825be567c2e89372d63c9b96f79)) - -## [3.7.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.7.0...typedoc-plugin-markdown@3.7.1) (2021-04-18) - -### Bug Fixes - -- Remove extraneous whitespace in table description col ([4e56ae4](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/4e56ae4d12be35f94ac0f7294fc67c66df04e3c1)) - -# [3.7.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.6.1...typedoc-plugin-markdown@3.7.0) (2021-04-17) - -### Features - -- Prefix table bars to beggining of lines ([064c0db](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/064c0dbecb194039d6a50d02ccc440116448c78a)) -- Use backticks and quote strings for literal types ([#212](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/212)) ([8949be1](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/8949be1608e60169d1f24393bf4257e38045b059)) - -## [3.6.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.6.0...typedoc-plugin-markdown@3.6.1) (2021-04-05) - -### Bug Fixes - -- Override section of methods overriding those of classes from node modules ([cb74e83](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/cb74e83116046aebb900f25f8348a74094b03901)) - -# [3.6.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.5.0...typedoc-plugin-markdown@3.6.0) (2021-02-27) - -### Bug Fixes - -- Expand signature return types. ([a348f53](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/a348f539ec91944cbb9e5a6a9ac26bf2cff5ec21)) - -### Features - -- Added `--hidePageTitle` option ([0b9588b](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/0b9588b4db764095b9e5e17ce004d494b92e167e)) -- Added Front matter utils ([a530828](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/a5308280662b0efe5d14f03a5854d26c5e42852e)) - -# [3.5.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.3.0...typedoc-plugin-markdown@3.5.0) (2021-02-15) - -### Bug Fixes - -- Added missing class accessor labels ([2b04924](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/2b0492431c27d781a9cc869fdd26eea8259894d6)) -- Include missing member type declarations ([84f5703](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/84f5703f6098f89bad7408d1fa1fb4b4d7b5dca6)) -- Remove emphasis inside angle brackets ([20c9605](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/20c9605d24dd9c39b49ff84d1b813bc661bb4c3b)) - -### Features - -- Conditionally display hierarchies ([#192](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/192)) ([099351c](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/099351cfc207718f9f577b6a8035bebe10e3fc34)) -- Flatten nested params ([#191](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/191)) ([9398d5c](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/9398d5c7f51e7b1e646a15d4c06bd3056f660aa8)) -- Left-align table headers ([76012ab](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/76012abb7fbbd972cf8143a03bb48d21898dc5d4)) - -# 3.4.5 (2021-01-26) - -### Bug Fixes - -- Escape pipes properly ([#187](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/191)) - -# 3.4.4 (2021-01-26) - -### Bug Fixes - -Fixed navigation structure when readme=none diff --git a/tools/typedoc-plugin-markdown/LICENSE b/tools/typedoc-plugin-markdown/LICENSE deleted file mode 100644 index f0039e40..00000000 --- a/tools/typedoc-plugin-markdown/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2016 Thomas Grey - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/tools/typedoc-plugin-markdown/README.md b/tools/typedoc-plugin-markdown/README.md deleted file mode 100644 index ec457f3c..00000000 --- a/tools/typedoc-plugin-markdown/README.md +++ /dev/null @@ -1,104 +0,0 @@ -# typedoc-plugin-markdown - -A plugin for [TypeDoc](https://typedoc.org) that renders TypeScript API documentation as Markdown. - -[![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg)](https://www.npmjs.com/package/typedoc-plugin-markdown) -[![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) - -## What does it do? - -By default, TypeDoc will render API documentation as a webpage, e.g. HTML files. - -The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options. This is useful if documentation is required to be included in project README files, Wikis and static site generators. - -## Installation - -**Please note this pre-release version may contain breaking changes within the same semantic version.** - -> [TypeDoc](https://typedoc.org) and [Prettier](https://prettier.io/) are both required peer dependencies. - -```bash -npm install typedoc-plugin-markdown@next --save-dev -``` - -## Usage - -```bash -typedoc --plugin typedoc-plugin-markdown -``` - -## Options - -The following options can be used in addition to relevant [TypeDoc options](https://typedoc.org/options/) -(please note that TypeDoc options specific to the HTML theme will be ignored). - -### File output and content organization - -- **`--outputFileStrategy`**
- Determines how output files are generated. Allowed values `modules` (all symbols hoisted to a single modules file) or `members` (each symbol exported to a seperate file). Default value `members`. -- **`--entryDocument`**
- The file name of the entry document. Default value `README.md`. -- **`--includeFileNumberPrefixes`**
- Prefixes generated files and folders with number prefixes. This is useful for auto sidebar generation. Defaults to `false`. -- **`--excludeGroups`**
- By default members are grouped by kind (eg Classes, Functions etc). This option excludes such groupings so all members are rendered and sorted at the same level. Defaults to `false`. - -Please see [File output and content organization](./docs/file-output-options.md) for further documentation. - -### UI options - -- **`--hidePageHeader`**
- Do not print the page header. Defaults to `false`. -- **`--hideBreadcrumbs`**
- Do not print breadcrumbs. Defaults to `false`. -- **`--hideInPageTOC`**
- Do not print in-page index items. Defaults to `false`. -- **`--hidePageTitle`**
- Do not print the page title. Defaults to `false`. -- **`--hideKindTag`**
- Do not print the kind tag identifiers for symbols. Defaults to `false`. -- **`--hideHierarchy`**
- Do not print reflection hierarchy. Defaults to `false`. -- **`--indexPageTitle`**
- The title of the main index / modules page. If not set will default to the project name. -- **`--indentifiersAsCodeBlocks`**
- Format signature and declaration identifiers in code blocks. Note if `true` references will not be linked. Defaults to `false`. -- **`--propertiesFormat`**
- Specify the render style of properties groups for interfaces, classes and type literals. Expected values [`list`, `table`]. Defaults to `list`. -- **`--enumMembersFormat`**
- Specify the render style of Enum members. Expected values [`list`, `table`]. Defaults to `list`. -- **`--typeDeclarationFormat`**
- Specify the render style for type declaration members. Expected values [`list`, `table`]. Defaults to `list`. - -### Utility options - -- **`--baseUrl`**
- Specifies the base url for internal link. If omitted all urls will be relative. Defaults to `.` -- **`--anchorFormat`**
- The anchor style to use when linking to internal symbols. Expected values [`lowercase`, `slug`, `none`]. Defaults to `lowercase`. -- **`--anchorPattern`**
- The anchor pattern to use when linking to internal symbols. e.g customprefix-{{anchor}}. -- **`--namedAnchors`**
- Use HTML named anchor tags for implementations that do not assign header ids. Defaults to `false`. - -## Frontmatter - -If frontmatter is required for adding further metadata please use [typedoc-plugin-frontmatter](https://github.com/tgreyuk/typedoc-plugin-frontmatter) - -## Output formatting (Prettier) - -Generated Markdown is now parsed with [Prettier](https://prettier.io/) which is backed by the remark-parse package. Parsing documents with Prettier has several benefits: - -- Produces a consistent format. -- Remove unnecessary escape characters. -- Formats code blocks inside comment fenced blocks. - -Any [prettier configuration](https://prettier.io/docs/en/configuration.html) files discovered will be passed as options to the parser. - -## Further Documentation - -- [File output options](./docs/file-output-options.md) - -## License - -[MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/LICENSE) diff --git a/tools/typedoc-plugin-markdown/docs/file-output-options.md b/tools/typedoc-plugin-markdown/docs/file-output-options.md deleted file mode 100644 index e04681f4..00000000 --- a/tools/typedoc-plugin-markdown/docs/file-output-options.md +++ /dev/null @@ -1,115 +0,0 @@ -# File output and content organization - -TypeDoc creates documentation according to exports. The module structure is drived from the `--entryPoints` configuration. https://typedoc.org/options/input/#entrypoints. - -All TypeDoc organization and sorting options will be adhered to https://typedoc.org/options/organization/. - -In addition, the plugin aims to provide some additional flexibility as to how files are generated. - -## Output folder structure - -By default the file structure is generated as per the project module structure. - -### --outputFileStrategy - -The plugin exposes an additional option `outputFileStrategy` that determines how files are generated. The options are `members` or `modules`. - -#### `members` (default) - -Each member is exported to its own file. This is the standard behaviour of the HTML theme and the plugin default. - -**typedoc.json** - -```js -{ - outputFileStrategy: 'members'; -} -``` - -**Folder structure** - -``` -├── README.md -├── index.md -│ ├── module.moduleA -| ├── index.md -| ├── classes -| ├── class.ClassA.md -│ ├── interfaces -| ├── interface.InterfaceA.md -│ ├── module.moduleB -| ├── index.md -| ├── classes -| ├── class.ClassA.md -│ ├── interfaces -| ├── interface.InterfaceA.md -``` - -#### `modules` - -This mode generates a single file for every Module and Namespace where all module members are hoisted. This creates a flat navigation structure and reduces the amount of files generated. - -**typedoc.json** - -```js -{ - outputFileStrategy: 'modules'; -} -``` - -**Folder structure** - -``` -├── README.md -├── index.md -├── module.moduleA.md -├── module.moduleB.md -``` - -### --includeFileNumberPrefixes - -The `--includeFileNumberPrefixesA` prefixes files and folders with number prefxies. This makes them appear in the file system in the same order when sorted by file name and is useful where auto sidebar generation may be required. - -**Folder structure** - -``` -├── index.md -│ ├── 01-module.moduleA -| ├── index.md -| ├── 01-Classes -| ├── 01-class.ClassA.md -| ├── 02-class.ClassB.md -│ ├── 02-Interfaces -| ├── 01-interface.InterfaceA.md -│ ├── 02-module.moduleB -``` - -### --excludeGroups - -By default members are grouped under their respecitve reflection kind headings: - -```markdown -# SomeModule - -## Classes - -### ClassA - -## Functions - -### FunctionA -``` - -This `excludeGroups` option excludes such grouping so all members are rendered and sorted at same level. - -```markdown -# SomeModule - -## ClassA - -## FunctionA -``` - -The is more relevant when `outputFileStrategy` equals `modules`. When `outputFileStrategy` equals `members` only the index page structure is effected. - -This will also effect the generated file output and remove the respective group folders. diff --git a/tools/typedoc-plugin-markdown/jest.config.js b/tools/typedoc-plugin-markdown/jest.config.js deleted file mode 100644 index 7f171502..00000000 --- a/tools/typedoc-plugin-markdown/jest.config.js +++ /dev/null @@ -1,6 +0,0 @@ -const base = require('../../jest.config.base.js'); - -module.exports = { - ...base, - displayName: 'typedoc-plugin-markdown', -}; diff --git a/tools/typedoc-plugin-markdown/package.json b/tools/typedoc-plugin-markdown/package.json deleted file mode 100644 index 0cc9ef56..00000000 --- a/tools/typedoc-plugin-markdown/package.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "name": "typedoc-plugin-markdown", - "version": "4.0.0-next.11", - "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.", - "main": "dist/index.js", - "files": [ - "dist/" - ], - "scripts": { - "lint": "npm-run-all lint:*", - "lint:ts": "eslint ./src --ext .ts", - "lint:markdown": "npm run docs && markdownlint ./out/md", - "prepublishOnly": "npm run lint && npm run build && npm run test", - "prebuild": "ts-node scripts/build-resources", - "build": "rm -rf dist && tsc", - "test": "jest --colors --updateSnapshot", - "build-and-test": "npm run build && npm run test", - "docs": "npm run build && npm-run-all docs:*", - "docs:md-1": "typedoc --options ../../stubs/typedoc.1.js --out ./out/md/md-1", - "docs:md-2": "typedoc --options ../../stubs/typedoc.2.js --out ./out/md/md-2", - "docs:md-3": "typedoc --options ../../stubs/typedoc.3.js --out ./out/md/md-3", - "docs:html": "typedoc --options ../../stubs/typedoc.base.js --out ./out/html" - }, - "author": "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": { - "prettier": ">=1.8.0", - "typedoc": ">=0.24.0" - } -} diff --git a/tools/typedoc-plugin-markdown/scripts/build-resources.ts b/tools/typedoc-plugin-markdown/scripts/build-resources.ts deleted file mode 100644 index def8cc1d..00000000 --- a/tools/typedoc-plugin-markdown/scripts/build-resources.ts +++ /dev/null @@ -1,150 +0,0 @@ -import * as fs from 'fs'; -import * as path from 'path'; -import { Project } from 'ts-morph'; - -const typedocSymbols = [ - 'ArrayType', - 'ConditionalType', - 'ContainerReflection', - 'Comment', - 'CommentDisplayPart', - 'DeclarationHierarchy', - 'DeclarationReflection', - 'InferredType', - 'IntersectionType', - 'IntrinsicType', - 'IndexedAccessType', - 'LiteralType', - 'PageEvent', - 'ParameterReflection', - 'ProjectReflection', - 'QueryType', - 'ReferenceReflection', - 'ReferenceType', - 'ReflectionType', - 'SignatureReflection', - 'SomeType', - 'TupleType', - 'TypeOperatorType', - 'TypeParameterReflection', - 'UnionType', - 'UnknownType', -]; - -const project = new Project({ - tsConfigFilePath: 'tsconfig.json', -}); - -const resourcesPath = path.join(__dirname, '..', 'src', 'resources'); - -const templateFiles = getFiles('templates'); -const templateSymbols = getSymbols(templateFiles, 'templates'); - -const partialsFiles = getFiles('partials'); -const partialsSymbols = getSymbols(partialsFiles, 'partials'); - -const out = [ - `// THIS FILE IS AUTOGENERATED - DO NOT EDIT DIRECTLY -import { \n ${typedocSymbols.join(',\n ')} } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../theme-render-context'; -import { Collapse, NavigationItem } from '../models';`, -]; - -templateFiles.forEach((file, index) => { - out.push( - `import { ${templateSymbols[index].symbolName} } from './templates/${file}';`, - ); -}); - -partialsFiles.forEach((file, index) => { - out.push( - `import { ${partialsSymbols[index].symbolName} } from './partials/${file}';`, - ); -}); - -out.push(` -function bind(fn: (f: F, ...a: L) => R, first: F) { - return (...r: L) => fn(first, ...r); -}`); - -out.push(`export type Templates = {`); -templateSymbols.forEach((symbol) => { - out.push(writeSymbol(symbol)); -}); -out.push(`};\n`); - -out.push(`export type Partials = {`); -partialsSymbols.forEach((symbol) => { - out.push(writeSymbol(symbol)); -}); -out.push(`};`); - -out.push( - ` -export const templates = (context: MarkdownThemeRenderContext): Templates => ({`, -); -templateSymbols.forEach((symbol) => { - out.push(` ${symbol.symbolName}: bind(${symbol.symbolName}, context),`); -}); -out.push(`});`); - -out.push( - ` -export const partials = (context: MarkdownThemeRenderContext): Partials => ({`, -); -partialsSymbols.forEach((symbol) => { - out.push(` ${symbol.symbolName}: bind(${symbol.symbolName}, context),`); -}); -out.push(`});`); - -fs.writeFileSync( - path.join(resourcesPath, 'resources.ts'), - out.join('\n') + '\n', -); - -function getFiles(type: string) { - const partialsFolder = path.join(resourcesPath, type); - return fs - .readdirSync(partialsFolder) - .map((partialsFile) => path.parse(partialsFile).name); -} - -function getSymbols(files: string[], type: string) { - return files.map((file) => { - const tsFile = project.getSourceFile( - path.join(resourcesPath, type, file + '.ts'), - ); - - const symbolName = tsFile?.getExportSymbols()[0]?.getEscapedName(); - const fn = tsFile?.getFunction(symbolName as string); - - const params = fn - ?.getParameters() - .filter((parameter) => parameter.getName() !== 'context') - .map((parameter) => { - const typeunions = parameter - .getType() - .getText() - .split('|') - .map((unions) => { - const union = unions.split('.'); - if (union[1] && union[1].startsWith('PageEvent')) { - return `PageEvent<${union[union.length - 1]}`; - } - return union[union.length - 1]; - }); - const name = parameter.getName(); - const isOptional = parameter.isOptional(); - return { name, type: typeunions.join('| '), isOptional }; - }); - return { symbolName, params }; - }); -} - -function writeSymbol(symbol: any) { - return ` ${symbol.symbolName}: (${symbol.params - ?.map( - (param) => `${param.name}${param.isOptional ? '?' : ''}: ${param.type}`, - ) - .join(', ')}) => string;`; -} diff --git a/tools/typedoc-plugin-markdown/src/converter/models.ts b/tools/typedoc-plugin-markdown/src/converter/models.ts deleted file mode 100644 index 392cc498..00000000 --- a/tools/typedoc-plugin-markdown/src/converter/models.ts +++ /dev/null @@ -1,7 +0,0 @@ -export interface UrlOption { - parentUrl?: string; - directory?: string | null; - forceDirectory?: boolean; - directoryPosition: number; - pagePosition: number; -} diff --git a/tools/typedoc-plugin-markdown/src/converter/navigation-builder.ts b/tools/typedoc-plugin-markdown/src/converter/navigation-builder.ts deleted file mode 100644 index a9c4c195..00000000 --- a/tools/typedoc-plugin-markdown/src/converter/navigation-builder.ts +++ /dev/null @@ -1,77 +0,0 @@ -import { - DeclarationReflection, - ProjectReflection, - ReflectionGroup, -} from 'typedoc'; - -import { NavigationItem } from '../models'; -import { MarkdownThemeRenderContext } from '../theme-render-context'; - -export class NavigationBuilder { - navigation: NavigationItem[] = []; - - constructor(public context: MarkdownThemeRenderContext) {} - - getNavigation(project: ProjectReflection): NavigationItem[] { - if (project.groups?.length) { - project.groups?.forEach(() => { - project.children?.forEach((child) => { - this.navigation.push({ - title: child.name, - url: child.url, - children: this.getChildrenOrGroups(child) || [], - }); - }); - }); - } else { - project.children?.forEach((child) => { - this.navigation.push({ - title: child.name, - children: this.getChildrenOrGroups(child) || [], - }); - }); - } - - return this.navigation; - } - - getGroupChildren(group: ReflectionGroup) { - if (group.categories) { - return group.categories?.map((category) => { - return { - title: category.title, - children: this.getGroupChildren(category) || [], - }; - }); - } - return group.children - ?.filter((child) => child.hasOwnDocument) - .map((child) => { - return { - title: child.name, - url: child.url, - children: this.getChildrenOrGroups(child) || [], - }; - }); - } - - getChildrenOrGroups(reflection: DeclarationReflection) { - if (this.context.getOption('excludeGroups')) { - return reflection.children - ?.filter((child) => child.hasOwnDocument) - .map((child) => { - return { - title: child.name, - url: child.url, - children: this.getChildrenOrGroups(child), - }; - }); - } - return reflection.groups?.map((group) => { - return { - title: group.title, - children: this.getGroupChildren(group) || [], - }; - }); - } -} diff --git a/tools/typedoc-plugin-markdown/src/converter/url-builder.ts b/tools/typedoc-plugin-markdown/src/converter/url-builder.ts deleted file mode 100644 index 5726ca16..00000000 --- a/tools/typedoc-plugin-markdown/src/converter/url-builder.ts +++ /dev/null @@ -1,429 +0,0 @@ -import * as path from 'path'; -import { - DeclarationReflection, - EntryPointStrategy, - PageEvent, - ProjectReflection, - Reflection, - ReflectionKind, - UrlMapping, -} from 'typedoc'; -import { OutputFileStrategy, TemplateMapping } from '../models'; -import { slugify } from '../support/utils'; -import { MarkdownThemeRenderContext } from '../theme-render-context'; -import { UrlOption } from './models'; - -export class UrlBuilder { - urls: UrlMapping[] = []; - anchors: string[] = []; - - constructor(public context: MarkdownThemeRenderContext) {} - - readmeTemplate = (pageEvent: PageEvent) => { - return this.context.templates.readmeTemplate(pageEvent); - }; - - projectTemplate = (pageEvent: PageEvent) => { - return this.context.templates.projectTemplate(pageEvent); - }; - - reflectionTemplate = (pageEvent: PageEvent) => { - return this.context.templates.reflectionTemplate(pageEvent); - }; - - memberTemplate = (pageEvent: PageEvent) => { - return this.context.templates.memberTemplate(pageEvent); - }; - - /** - * Map the models of the given project to the desired output files. - * Based on TypeDoc DefaultTheme.getUrls() - * - * @param project The project whose urls should be generated. - */ - getUrls(project: ProjectReflection): UrlMapping[] { - const entryDocument = this.context.getOption('entryDocument'); - const globalsPage = - this.context.getOption('entryPoints')?.length > 1 - ? this.context.modulesFile - : this.context.exportsFile; - if (!this.context.getOption('readme')?.endsWith('none')) { - project.url = this.getPartName(globalsPage, 1); - this.urls.push( - new UrlMapping( - this.context.getOption('entryDocument'), - project, - this.readmeTemplate, - ), - ); - - this.urls.push( - new UrlMapping( - this.getPartName(globalsPage, 1), - project, - this.projectTemplate, - ), - ); - } else { - project.url = entryDocument; - this.urls.push( - new UrlMapping(entryDocument, project, this.projectTemplate), - ); - } - - if ( - (this.context.getOption( - 'entryPointStrategy', - ) as unknown as EntryPointStrategy) === 'packages' - ) { - project.children?.forEach((projectChild, projectChildIndex) => { - const startIndex = !this.context.getOption('readme')?.endsWith('none') - ? 2 - : 1; - const directoryPosition = projectChildIndex + startIndex; - const url = `${this.getPartName( - projectChild.name, - directoryPosition, - )}/${ - Boolean(projectChild.readme) - ? this.getPartName(this.context.indexFile, 1) - : this.context.indexFile - }`; - if (projectChild.readme) { - this.urls.push( - new UrlMapping( - `${path.dirname(url)}/${this.context.readmeFile}`, - projectChild as any, - this.readmeTemplate, - ), - ); - } - this.urls.push( - new UrlMapping(url, projectChild as any, this.projectTemplate), - ); - projectChild.url = url; - this.buildUrlsFromProject(projectChild, url); - }); - } else { - this.buildUrlsFromProject(project); - } - - return this.urls; - } - - /** - * - * @param project - * @param isPackage - */ - private buildUrlsFromProject( - project: ProjectReflection | DeclarationReflection, - parentUrl?: string, - ) { - const startIndex = Boolean(project.readme) ? 2 : 1; - - if (this.context.getOption('excludeGroups')) { - project.children?.forEach((projectGroupChild, projectGroupChildIndex) => { - this.buildUrlsFromGroup(projectGroupChild, { - directoryPosition: projectGroupChildIndex + startIndex, - pagePosition: projectGroupChildIndex + startIndex, - ...(parentUrl && { parentUrl: parentUrl }), - }); - }); - } else { - project.groups?.forEach((projectGroup, projectGroupIndex) => { - projectGroup.children.forEach( - (projectGroupChild, projectGroupChildIndex) => { - this.buildUrlsFromGroup(projectGroupChild, { - directoryPosition: projectGroupIndex + startIndex, - pagePosition: projectGroupChildIndex + startIndex, - ...(parentUrl && { parentUrl: parentUrl }), - }); - }, - ); - }); - } - } - - private buildUrlsFromGroup( - reflection: DeclarationReflection, - options: UrlOption, - ) { - const mapping = this.getTemplateMapping(reflection.kind); - if (mapping) { - const directory = options.directory || mapping.directory; - const url = this.getUrl(reflection, { - ...options, - directory, - }); - - this.urls.push(new UrlMapping(url, reflection, mapping.template)); - - reflection.url = url; - reflection.hasOwnDocument = true; - - if (this.context.getOption('excludeGroups')) { - if (reflection.categories) { - reflection.categories.forEach((category, categoryIndex) => { - category.children.forEach((categoryChild, categoryChildIndex) => { - this.buildUrlsFromGroup(categoryChild, { - parentUrl: url, - directoryPosition: categoryIndex + 1, - directory: category.title, - pagePosition: categoryChildIndex + 1, - forceDirectory: true, - }); - }); - }); - } else { - reflection.children?.forEach((groupChild, groupChildIndex) => { - this.buildUrlsFromGroup(groupChild, { - parentUrl: url, - directoryPosition: groupChildIndex + 1, - directory: null, - pagePosition: groupChildIndex + 1, - }); - }); - } - } else { - reflection.groups?.forEach((group, groupIndex) => { - if (group.categories) { - group.categories.forEach((category, categoryIndex) => { - category.children.forEach((categoryChild, categoryChildIndex) => { - const mapping = this.getTemplateMapping(categoryChild.kind); - this.buildUrlsFromGroup(categoryChild, { - parentUrl: url, - directoryPosition: groupIndex + 1, - directory: `${mapping?.directory}/${this.getPartName( - category.title, - categoryIndex + 1, - )}`, - pagePosition: categoryChildIndex + 1, - }); - }); - }); - } else { - group.children.forEach((groupChild, groupChildIndex) => { - const mapping = this.getTemplateMapping(groupChild.kind); - this.buildUrlsFromGroup(groupChild, { - parentUrl: url, - directoryPosition: groupIndex + 1, - directory: mapping?.directory || null, - pagePosition: groupChildIndex + 1, - }); - }); - } - }); - } - } else if (reflection.parent) { - this.applyAnchorUrl(reflection, reflection.parent); - } - } - - private getUrl(reflection: DeclarationReflection, options: UrlOption) { - if (this.context.getOption('flattenOutputFiles')) { - const kindAlias = ReflectionKind.singularString(reflection.kind).split( - ' ', - )[0]; - if (options.parentUrl) { - return `${path - .dirname(options.parentUrl.split('.').join('/')) - .split('/') - .join('.')}.${kindAlias}.${reflection.name.replace(/\//, '_')}.md`; - } - const friendlyName = `${reflection.name.replace(/\//, '_')}.md`; - return reflection.kindOf(ReflectionKind.Module) - ? friendlyName - : `${kindAlias}.${friendlyName}`; - } - - // remove leading underscores - const alias = reflection.getAlias().replace(/^_/, ''); - - const parentDir = options.parentUrl - ? path.dirname(options.parentUrl) - : null; - - const dir = () => { - if (reflection.kindOf(ReflectionKind.Namespace)) { - if (!this.context.getOption('excludeGroups')) { - return this.getPartName( - `${options.directory}/${this.getPartName( - 'namespace.' + alias, - options.pagePosition, - )}`, - options.directoryPosition, - ); - } - return this.getPartName(alias, options.pagePosition); - } - - if ( - options.directory && - this.context.getOption('excludeGroups') && - !options.forceDirectory - ) { - return null; - } - - return options.directory - ? this.getPartName(options.directory, options.directoryPosition) - : `${this.getPartName( - slugify(ReflectionKind.singularString(reflection.kind)), - options.pagePosition, - )}.${alias}`; - }; - - const filename = () => { - if ( - reflection.kindOf([ReflectionKind.Module, ReflectionKind.Namespace]) && - this.context.getOption('outputFileStrategy') === - OutputFileStrategy.Modules && - !this.childrenIncludeNamespaces(reflection) - ) { - return null; - } - if ( - reflection.kindOf([ReflectionKind.Module, ReflectionKind.Namespace]) - ) { - return path.parse(this.context.indexFile).name; - } - return `${this.getPartName( - slugify(ReflectionKind.singularString(reflection.kind)), - options.pagePosition, - )}.${alias}`; - }; - - return ( - [parentDir, dir(), filename()].filter((part) => Boolean(part)).join('/') + - '.md' - ); - } - - private applyAnchorUrl( - reflection: DeclarationReflection, - container: Reflection, - ) { - if (container.url && !reflection.url) { - if (!reflection.kindOf(ReflectionKind.TypeLiteral)) { - const anchorPattern = this.context.getOption('anchorPattern'); - const anchorId = anchorPattern - ? anchorPattern.replace('{{anchor}}', this.getAnchorId(reflection)) - : this.getAnchorId(reflection); - - const count = this.anchors[container.url]?.filter( - (id) => id === anchorId, - )?.length; - - const anchor = - anchorId + (count > 1 ? '-' + (count - 1).toString() : ''); - this.anchors.push(anchorId); - - reflection.url = container.url + '#' + anchor; - reflection.anchor = anchor; - } - reflection.hasOwnDocument = false; - } - reflection.traverse((child) => { - if (child instanceof DeclarationReflection) { - this.applyAnchorUrl(child, container); - } - }); - } - - private getAnchorId(reflection: DeclarationReflection) { - const anchorFormat = this.context.getOption('anchorFormat'); - if (anchorFormat.toLowerCase() === 'lowercase') { - return reflection.name.toLowerCase(); - } - if (anchorFormat.toLowerCase() === 'slug') { - return slugify(reflection.name); - } - return reflection.name; - } - - private getPartName(part: string, position: number) { - return this.context.getOption('includeFileNumberPrefixes') - ? `${String(position).padStart(2, '0')}-${part}` - : part; - } - - private childrenIncludeNamespaces(reflection: DeclarationReflection) { - return reflection.children?.some((child) => - child.kindOf(ReflectionKind.Namespace), - ); - } - - /** - * Returns the template mapping for a given reflection kind - * @param kind - */ - private getTemplateMapping(kind: ReflectionKind): TemplateMapping { - const getDirectoryName = (reflectionKind: ReflectionKind) => { - const pluralString = ReflectionKind.pluralString(reflectionKind); - return this.context.getOption('includeFileNumberPrefixes') - ? pluralString - : slugify(pluralString); - }; - - const outputFileStrategy = this.context.getOption('outputFileStrategy'); - - const mappings = { - [ReflectionKind.Module]: { - template: this.reflectionTemplate, - directory: null, - kind: ReflectionKind.Module, - }, - [ReflectionKind.Namespace]: { - template: this.reflectionTemplate, - directory: getDirectoryName(ReflectionKind.Namespace), - kind: ReflectionKind.Namespace, - }, - }; - - if (outputFileStrategy === OutputFileStrategy.Members) { - mappings[ReflectionKind.Class] = { - template: this.reflectionTemplate, - directory: getDirectoryName(ReflectionKind.Class), - kind: ReflectionKind.Class, - }; - } - if (outputFileStrategy === OutputFileStrategy.Members) { - mappings[ReflectionKind.Interface] = { - isLeaf: false, - template: this.reflectionTemplate, - directory: getDirectoryName(ReflectionKind.Interface), - kind: ReflectionKind.Interface, - }; - } - if (outputFileStrategy === OutputFileStrategy.Members) { - mappings[ReflectionKind.Enum] = { - template: this.reflectionTemplate, - directory: getDirectoryName(ReflectionKind.Enum), - kind: ReflectionKind.Enum, - }; - } - if (outputFileStrategy === OutputFileStrategy.Members) { - mappings[ReflectionKind.Function] = { - template: this.memberTemplate, - directory: getDirectoryName(ReflectionKind.Function), - kind: ReflectionKind.Function, - }; - } - if (outputFileStrategy === OutputFileStrategy.Members) { - mappings[ReflectionKind.TypeAlias] = { - template: this.memberTemplate, - directory: getDirectoryName(ReflectionKind.TypeAlias), - kind: ReflectionKind.TypeAlias, - }; - } - if (outputFileStrategy === OutputFileStrategy.Members) { - mappings[ReflectionKind.Variable] = { - template: this.memberTemplate, - directory: getDirectoryName(ReflectionKind.Variable), - kind: ReflectionKind.Variable, - }; - } - return mappings[kind]; - } -} diff --git a/tools/typedoc-plugin-markdown/src/index.ts b/tools/typedoc-plugin-markdown/src/index.ts deleted file mode 100644 index 52619752..00000000 --- a/tools/typedoc-plugin-markdown/src/index.ts +++ /dev/null @@ -1,35 +0,0 @@ -import { Application } from 'typedoc'; -import { declareOptions } from './options/options'; -import { generateMarkdown, renderMarkdown } from './renderer/renderer'; -import { MarkdownTheme } from './theme'; - -export function load(app: Application) { - /** - * Exposes markdown and bootstrap the markdown theme to the renderer - */ - app.renderer.defineTheme('markdown', MarkdownTheme); - - /** - * Defines all plugin options - */ - declareOptions(app); - - /** - * Decouple HTML logic from the renderer (there should probably be a better solution to this) - */ - Object.defineProperty(app, 'generateDocs', { value: generateMarkdown }); - Object.defineProperty(app.renderer, 'render', { - value: renderMarkdown, - configurable: true, - }); -} - -/** - * Expose global entrypoints - */ -export * from './models'; -export * from './options/options-reader'; -export { MarkdownRendererEvent } from './renderer/renderer'; -export { partials } from './resources/resources'; -export { MarkdownTheme } from './theme'; -export { MarkdownThemeRenderContext } from './theme-render-context'; diff --git a/tools/typedoc-plugin-markdown/src/models.ts b/tools/typedoc-plugin-markdown/src/models.ts deleted file mode 100644 index 5cea976a..00000000 --- a/tools/typedoc-plugin-markdown/src/models.ts +++ /dev/null @@ -1,79 +0,0 @@ -import { ReflectionKind, TypeDocOptionMap } from 'typedoc'; - -/** - * Defines outputFileStrategy options - * @enum - */ -export const OutputFileStrategy = { - Modules: 'modules', - Members: 'members', -} as const; - -export type OutputFileStrategy = - (typeof OutputFileStrategy)[keyof typeof OutputFileStrategy]; - -/** - * Defines format style options - * @enum - */ -export const FormatStyle = { - List: 'list', - Table: 'table', -} as const; - -export type FormatStyle = (typeof FormatStyle)[keyof typeof FormatStyle]; - -/** - * Defines format style options - * @enum - */ -export const AnchorFormat = { - Lowercase: 'lowercase', - Slug: 'slug', - None: 'none', -} as const; - -export type AnchorFormat = (typeof AnchorFormat)[keyof typeof AnchorFormat]; - -export interface TypedocPluginMarkdownOptions extends TypeDocOptionMap { - anchorFormat: AnchorFormat; - anchorPattern: string; - baseUrl: string; - entryDocument: string; - enumMembersFormat: FormatStyle; - excludeGroups: boolean; - flattenOutputFiles: boolean; - hideBreadcrumbs: boolean; - hideInPageTOC: boolean; - hideKindTag: boolean; - hidePageHeader: boolean; - hidePageTitle: boolean; - hideHierarchy: boolean; - includeFileNumberPrefixes: boolean; - indentifiersAsCodeBlocks: boolean; - indexPageTitle: string; - namedAnchors: boolean; - outputFileStrategy: OutputFileStrategy; - propertiesFormat: FormatStyle; - typeDeclarationFormat: FormatStyle; -} - -export interface TemplateMapping { - directory: string | null; - template: any; - kind: ReflectionKind; -} - -export type Collapse = 'object' | 'function' | 'all' | 'none'; - -export type FrontmatterGlobals = - | string - | Record; - -export interface NavigationItem { - title: string; - url?: string; - children?: NavigationItem[]; - isReadme?: boolean; - isGroup?: boolean; -} diff --git a/tools/typedoc-plugin-markdown/src/options/options-reader.ts b/tools/typedoc-plugin-markdown/src/options/options-reader.ts deleted file mode 100644 index 240649ea..00000000 --- a/tools/typedoc-plugin-markdown/src/options/options-reader.ts +++ /dev/null @@ -1,35 +0,0 @@ -import { Options, OptionsReader } from 'typedoc'; -import { TypedocPluginMarkdownOptions } from '../models'; - -export class MarkdownPluginOptionsReader - implements OptionsReader -{ - options: Partial; - - name = 'custom-options'; - order = 1000; - readonly supportsPackages = false; - - constructor(options: Partial) { - this.options = options; - } - - read(container: Options) { - if (this.options) { - Object.entries(this.options).forEach(([key, value]) => { - if (key === 'plugin') { - const plugins = container.getValue('plugin'); - const defaultPlugins = value as string[]; - defaultPlugins.forEach((defaultPlugin) => { - if (!plugins.includes(defaultPlugin)) { - plugins.push(defaultPlugin); - } - }); - container.setValue('plugin', plugins); - } else { - container.setValue(key, value); - } - }); - } - } -} diff --git a/tools/typedoc-plugin-markdown/src/options/options.ts b/tools/typedoc-plugin-markdown/src/options/options.ts deleted file mode 100644 index e988c0a9..00000000 --- a/tools/typedoc-plugin-markdown/src/options/options.ts +++ /dev/null @@ -1,190 +0,0 @@ -import { Application, Options, OptionsReader, ParameterType } from 'typedoc'; -import { AnchorFormat, FormatStyle, OutputFileStrategy } from '../models'; - -export function declareOptions(app: Application) { - app.options.addReader( - new (class implements OptionsReader { - name = 'markdown-theme'; - readonly order = 900; - readonly supportsPackages = false; - read(container: Options) { - if (container.getValue('theme') === 'default') { - container.setValue('theme', 'markdown'); - } - - if (container.getValue('excludeGroups')) { - container.setValue('categorizeByGroup', false); - } - } - })(), - ); - /** - * file output options - */ - - app.options.addDeclaration({ - name: 'outputFileStrategy', - help: 'Determines how files are rendered.', - type: ParameterType.Map, - map: OutputFileStrategy, - defaultValue: OutputFileStrategy.Members, - }); - - app.options.addDeclaration({ - name: 'entryDocument', - help: '[Markdown Plugin] The file name of the entry document.', - type: ParameterType.String, - defaultValue: 'README.md', - }); - - app.options.addDeclaration({ - name: 'flattenOutputFiles', - help: '[Markdown Plugin] Flatten output files without folders.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'includeFileNumberPrefixes', - help: '[Markdown Plugin] Prefixes docs and folders by number prefixes if applicable.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'excludeGroups', - help: '[Markdown Plugin] Groups reflection kinds by headings if applicable e.g Classes, Functions. If set to false all symbols will render on the same level. Defaults to `true`', - type: ParameterType.Boolean, - defaultValue: false, - }); - - /** - * ui options - */ - - app.options.addDeclaration({ - name: 'hidePageHeader', - help: '[Markdown Plugin] Do not print page header.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'hidePageTitle', - help: '[Markdown Plugin] Do not print page title.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'hideKindTag', - help: '[Markdown Plugin] Do not print the kind tag beneath the page title.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'hideBreadcrumbs', - help: '[Markdown Plugin] Do not print breadcrumbs.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'hideInPageTOC', - help: '[Markdown Plugin] Do not render in-page table of contents items.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'hideHierarchy', - help: '[Markdown Plugin] Do not print reflection hierarchy.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'indexPageTitle', - help: '[Markdown Plugin] The title of the main index / modules page.', - type: ParameterType.String, - }); - - app.options.addDeclaration({ - name: 'indentifiersAsCodeBlocks', - help: '[Markdown Plugin] Format signature and declaration identifiers in code blocks.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'propertiesFormat', - help: '[Markdown Plugin] Specify the render style of properties.', - type: ParameterType.Map, - map: FormatStyle, - defaultValue: FormatStyle.List, - }); - - app.options.addDeclaration({ - name: 'enumMembersFormat', - help: '[Markdown Plugin] Specify the render style of enum members.', - type: ParameterType.Map, - map: FormatStyle, - defaultValue: FormatStyle.List, - }); - - app.options.addDeclaration({ - name: 'typeDeclarationFormat', - help: '[Markdown Plugin] Specify the render style of type declration members.', - type: ParameterType.Map, - map: FormatStyle, - defaultValue: FormatStyle.List, - }); - - /** - * Frontmatter options (TO BE DELETED) - */ - app.options.addDeclaration({ - name: 'enableFrontmatter', - help: '[Markdown Plugin] Removed (please use typedoc-plugin-fronmatter)', - type: ParameterType.Boolean, - defaultValue: false, - }); - - /** - * Utility options - */ - app.options.addDeclaration({ - help: '[Markdown Plugin] Specifies the base url for internal link. If omitted all urls will be relative.', - name: 'baseUrl', - type: ParameterType.String, - }); - - app.options.addDeclaration({ - name: 'anchorFormat', - help: '[Markdown Plugin] The anchor format to use when linking to internal symbols.', - type: ParameterType.Map, - map: AnchorFormat, - defaultValue: AnchorFormat.Lowercase, - }); - - app.options.addDeclaration({ - name: 'anchorPattern', - help: '[Markdown Plugin] The anchor pattern to use when linking to internal symbols. e.g customprefix-{{anchor}}.', - type: ParameterType.String, - }); - - app.options.addDeclaration({ - name: 'namedAnchors', - help: '[Markdown Plugin] Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids. Should be set for Bitbucket Server docs.', - type: ParameterType.Boolean, - defaultValue: false, - }); - - app.options.addDeclaration({ - name: 'preserveAnchorCasing', - help: '[Markdown Plugin] Preserve anchor casing when generating links.', - type: ParameterType.Boolean, - defaultValue: false, - }); -} diff --git a/tools/typedoc-plugin-markdown/src/renderer/renderer.ts b/tools/typedoc-plugin-markdown/src/renderer/renderer.ts deleted file mode 100644 index 38ded8e2..00000000 --- a/tools/typedoc-plugin-markdown/src/renderer/renderer.ts +++ /dev/null @@ -1,108 +0,0 @@ -import * as fs from 'fs'; -import * as path from 'path'; -import { - DeclarationReflection, - ProjectReflection, - RendererEvent, -} from 'typedoc'; -import { NavigationItem } from '../models'; - -export class MarkdownRendererEvent extends RendererEvent { - navigation: NavigationItem[]; -} - -export async function generateMarkdown( - project: ProjectReflection, - out: string, -) { - const start = Date.now(); - - out = path.resolve(out); - - await this.renderer.render(project, out); - - if (this.logger.hasErrors()) { - this.logger.error( - 'Documentation could not be generated due to the errors above.', - ); - } else { - this.logger.info(`Documentation generated at ${out}`); - - this.logger.verbose(`Markdown rendering took ${Date.now() - start}ms`); - } -} - -export async function renderMarkdown( - project: ProjectReflection, - outputDirectory: string, -): Promise { - this.renderStartTime = Date.now(); - - if (this.cleanOutputDir) { - try { - fs.rmSync(outputDirectory, { recursive: true, force: true }); - } catch (error) { - this.application.logger.warn('Could not empty the output directory.'); - return; - } - } - - try { - fs.mkdirSync(outputDirectory, { recursive: true }); - } catch (error) { - this.application.l.error( - `Could not create output directory ${outputDirectory}.`, - ); - return; - } - - if (this.githubPages) { - try { - const text = - 'TypeDoc added this file to prevent GitHub Pages from ' + - 'using Jekyll. You can turn off this behavior by setting ' + - 'the `githubPages` option to false.'; - - fs.writeFileSync(path.join(outputDirectory, '.nojekyll'), text); - } catch (error) { - this.application.warn('Could not create .nojekyll file.'); - return; - } - } - - this.prepareTheme(); - - const output = new MarkdownRendererEvent( - RendererEvent.BEGIN, - outputDirectory, - project, - ); - - output.urls = this.theme!.getUrls(project); - output.navigation = this.theme!.getNavigation(project); - - this.trigger(output); - - await Promise.all(this.preRenderAsyncJobs.map((job) => job(output))); - this.preRenderAsyncJobs = []; - - this.application.logger.verbose( - `There are ${output.urls?.length} pages to write.`, - ); - output.urls - ?.filter( - (urlMapping) => - urlMapping.model instanceof ProjectReflection || - urlMapping.model instanceof DeclarationReflection, - ) - .forEach((urlMapping) => { - this.renderDocument(...output.createPageEvent(urlMapping)); - }); - - await Promise.all(this.postRenderAsyncJobs.map((job) => job(output))); - this.postRenderAsyncJobs = []; - - this.trigger(RendererEvent.END, output); - - this.theme = void 0; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/breadcrumbs.ts b/tools/typedoc-plugin-markdown/src/resources/partials/breadcrumbs.ts deleted file mode 100644 index 6351323d..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/breadcrumbs.ts +++ /dev/null @@ -1,46 +0,0 @@ -import { DeclarationReflection, PageEvent, ProjectReflection } from 'typedoc'; -import { link } from '../../support/els'; -import { escapeChars } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function breadcrumbs( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const md: string[] = []; - - if (page.url === page.project.url || page.url === context.indexFile) { - return ''; - } - - md.push( - link( - Boolean(page.project.groups) - ? context.getOption('entryPoints').length > 1 - ? 'Modules' - : 'Exports' - : 'Packages', - context.relativeURL(page.project.url), - ), - ); - - const breadcrumb = (model: any) => { - if (model?.parent?.parent) { - breadcrumb(model.parent); - } - md.push(link(model.name, context.relativeURL(model?.url))); - }; - - const pageName = escapeChars(page.model.name); - - if ( - page.model?.parent?.parent && - (page.url !== page.project.url || page.url !== context.indexFile) - ) { - breadcrumb(page.model.parent); - } - - md.push(pageName); - - return md.length > 1 ? `${md.join(' > ')}` : ''; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/comment.parts.ts b/tools/typedoc-plugin-markdown/src/resources/partials/comment.parts.ts deleted file mode 100644 index 98136a20..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/comment.parts.ts +++ /dev/null @@ -1,45 +0,0 @@ -import { CommentDisplayPart } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function commentParts( - context: MarkdownThemeRenderContext, - parts: CommentDisplayPart[], -) { - const md: string[] = []; - for (const part of parts) { - switch (part.kind) { - case 'text': - case 'code': - md.push(part.text); - break; - case 'inline-tag': - switch (part.tag) { - case '@label': - case '@inheritdoc': - break; - case '@link': - case '@linkcode': - case '@linkplain': { - if (part.target) { - const url = - typeof part.target === 'string' - ? part.target - : context.relativeURL((part.target as any).url); - const wrap = part.tag === '@linkcode' ? '`' : ''; - md.push(url ? `[${wrap}${part.text}${wrap}](${url})` : part.text); - } else { - md.push(part.text); - } - break; - } - default: - md.push(`{${part.tag} ${part.text}}`); - break; - } - break; - default: - md.push(''); - } - } - return md.join(''); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/comment.ts b/tools/typedoc-plugin-markdown/src/resources/partials/comment.ts deleted file mode 100644 index fc1ca270..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/comment.ts +++ /dev/null @@ -1,34 +0,0 @@ -import { Comment } from 'typedoc'; -import { backTicks, heading } from '../../support/els'; -import { getTagName } from '../../support/helpers'; -import { camelToTitleCase, escapeAngleBrackets } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function comment( - context: MarkdownThemeRenderContext, - comment: Comment, - headingLevel?: number, -) { - const md: string[] = []; - - if (comment.summary?.length > 0) { - md.push(context.partials.commentParts(comment.summary)); - } - - if (comment.blockTags?.length) { - const tags = comment.blockTags - .filter((tag) => tag.tag !== '@returns') - .map((tag) => { - const tagName = getTagName(tag); - const tagText = camelToTitleCase(tagName); - const tagMd = [ - headingLevel ? heading(headingLevel, tagText) : backTicks(tagText), - ]; - tagMd.push(context.partials.commentParts(tag.content)); - return tagMd.join('\n\n'); - }); - md.push(tags.join('\n\n')); - } - - return escapeAngleBrackets(md.join('\n\n')); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/hierarchy.ts b/tools/typedoc-plugin-markdown/src/resources/partials/hierarchy.ts deleted file mode 100644 index aec62f65..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/hierarchy.ts +++ /dev/null @@ -1,48 +0,0 @@ -import { DeclarationHierarchy, SomeType, Type } from 'typedoc'; -import { backTicks, bold, unorderedList } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function hierarchy( - context: MarkdownThemeRenderContext, - declarationHierarchy: DeclarationHierarchy, -) { - const md: string[] = []; - const parent = !declarationHierarchy.isTarget - ? declarationHierarchy.types - .map((hierarchyType) => { - return getHierarchyType( - hierarchyType, - declarationHierarchy.isTarget || false, - context, - ); - }) - .join('.') - : null; - if (declarationHierarchy.next) { - declarationHierarchy.next.types.forEach((hierarchyType) => { - const line: string[] = []; - if (parent) { - line.push(parent); - } - line.push( - getHierarchyType( - hierarchyType, - declarationHierarchy.next?.isTarget || false, - context, - ), - ); - md.push(line.join('.')); - }); - } - return unorderedList(md); -} - -function getHierarchyType( - hierarchyType: Type, - isTarget: boolean, - context: MarkdownThemeRenderContext, -) { - return isTarget - ? bold(backTicks(hierarchyType.toString())) - : context.partials.someType(hierarchyType as SomeType); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.identifier.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.identifier.ts deleted file mode 100644 index d17bc304..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.identifier.ts +++ /dev/null @@ -1,64 +0,0 @@ -import { DeclarationReflection, ReflectionKind } from 'typedoc'; -import { backTicks } from '../../support/els'; -import { getDeclarationType } from '../../support/helpers'; -import { stripComments, stripLineBreaks } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function declarationMemberIdentifier( - context: MarkdownThemeRenderContext, - reflection: DeclarationReflection, -) { - const md: string[] = []; - - const declarationType = getDeclarationType(reflection); - - if ( - reflection.flags?.length && - !reflection.flags.isRest && - !reflection.flags.isOptional - ) { - md.push( - reflection.flags.map((flag) => backTicks(flag.toLowerCase())).join(' '), - ); - } - - if (reflection.kindOf(ReflectionKind.Variable) && !reflection.flags.isConst) { - md.push(backTicks('let')); - } - - if (reflection.flags.isRest) { - md.push('...'); - } - - const name: string[] = [context.partials.declarationMemberName(reflection)]; - - if (reflection.flags.isOptional) { - name.push('?'); - } - - if (declarationType) { - name.push(':'); - } - - md.push(name.join('')); - - if (reflection.typeParameters) { - md.push( - `\\<${reflection.typeParameters - ?.map((typeParameter) => backTicks(typeParameter.name)) - .join(', ')}\\>`, - ); - } - - if (declarationType) { - md.push(`${context.partials.someType(declarationType, 'all')}`); - } - - if (reflection.defaultValue && reflection.defaultValue !== '...') { - md.push( - ` = \`${stripLineBreaks(stripComments(reflection.defaultValue))}\``, - ); - } - - return md.join(' '); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.name.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.name.ts deleted file mode 100644 index b991d69f..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.name.ts +++ /dev/null @@ -1,39 +0,0 @@ -import { DeclarationReflection } from 'typedoc'; -import { bold } from '../../support/els'; -import { escapeChars } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function declarationMemberName( - context: MarkdownThemeRenderContext, - declaration: DeclarationReflection, - emphasis = true, -) { - if (Boolean(declaration.getSignature || Boolean(declaration.setSignature))) { - if (declaration.getSignature) { - return `${'get'} ${getName( - `${declaration.getSignature.name}()`, - emphasis, - )}`; - } else if (declaration.setSignature) { - return `${'set'} ${getName( - declaration.setSignature.name, - emphasis, - )}(${declaration.setSignature.parameters?.map((parameter) => { - return parameter.type - ? `${parameter.name}: ${context.partials.someType( - parameter.type, - 'all', - )}` - : ''; - })})`; - } - } - return getName(declaration.name, emphasis); -} - -function getName(name: string, emphasis: boolean) { - if (emphasis) { - return bold(escapeChars(name)); - } - return escapeChars(name); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.ts deleted file mode 100644 index 8e23a755..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.declaration.ts +++ /dev/null @@ -1,89 +0,0 @@ -import { DeclarationReflection, ReflectionKind } from 'typedoc'; -import { blockQuoteBlock, codeBlock, heading } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function declarationMember( - context: MarkdownThemeRenderContext, - declaration: DeclarationReflection, - headingLevel: number, -) { - const md: string[] = []; - - const typeDeclaration = (declaration.type as any) - ?.declaration as DeclarationReflection; - - if (context.getOption('indentifiersAsCodeBlocks')) { - md.push( - codeBlock(context.partials.declarationMemberIdentifier(declaration)), - ); - } else { - md.push(`> ${context.partials.declarationMemberIdentifier(declaration)}`); - } - - if (declaration.comment) { - md.push(context.partials.comment(declaration.comment, headingLevel)); - } - - if (declaration.sources) { - md.push(context.partials.sources(declaration)); - } - - if (declaration.typeParameters) { - md.push(heading(headingLevel, `Type parameters`)); - md.push(context.partials.typeParametersTable(declaration.typeParameters)); - } - - if (typeDeclaration) { - if (typeDeclaration?.indexSignature) { - md.push(heading(headingLevel, `Index signature`)); - md.push( - context.partials.indexSignatureTitle(typeDeclaration.indexSignature), - ); - } - - if ( - typeDeclaration?.signatures?.length || - typeDeclaration?.children?.length - ) { - if (typeDeclaration?.parent?.kindOf(ReflectionKind.Property)) { - md.push( - heading( - headingLevel, - `Type declaration (${typeDeclaration.parent?.name})`, - ), - ); - } else { - md.push(heading(headingLevel, `Type declaration`)); - } - - if (typeDeclaration?.signatures?.length) { - typeDeclaration.signatures.forEach((signature) => { - if (typeDeclaration?.parent?.kindOf(ReflectionKind.Property)) { - md.push( - blockQuoteBlock( - context.partials.signatureMember(signature, headingLevel + 1), - ), - ); - } else { - md.push( - context.partials.signatureMember(signature, headingLevel + 1), - ); - } - }); - } - - if (typeDeclaration?.children?.length) { - md.push( - context.partials.typeDeclarationMember( - typeDeclaration, - headingLevel + 1, - ), - ); - } - } - } - - md.push(context.partials.inheritance(declaration, headingLevel)); - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.indexsignature.title.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.indexsignature.title.ts deleted file mode 100644 index 2ad225f6..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.indexsignature.title.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { SignatureReflection } from 'typedoc'; -import { backTicks } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function indexSignatureTitle( - context: MarkdownThemeRenderContext, - signature: SignatureReflection, -) { - const md = ['']; - const params = signature.parameters - ? signature.parameters.map((parameter) => { - return parameter.type - ? `${backTicks(parameter.name)}: ${context.partials.someType( - parameter.type, - )}` - : ''; - }) - : []; - if (signature.type) { - md.push( - `\\[${params.join('')}\\]: ${context.partials.someType(signature.type)}`, - ); - } - return md.join(' '); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.inheritance.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.inheritance.ts deleted file mode 100644 index a8584a61..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.inheritance.ts +++ /dev/null @@ -1,84 +0,0 @@ -import { - ArrayType, - DeclarationReflection, - ReferenceType, - SignatureReflection, -} from 'typedoc'; -import { backTicks, heading, link } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -import { escapeChars } from '../../support/utils'; - -export function inheritance( - context: MarkdownThemeRenderContext, - reflection: DeclarationReflection | SignatureReflection, - headingLevel: number, -) { - const md: string[] = []; - - if (reflection.implementationOf) { - md.push(heading(headingLevel, 'Implementation of')); - md.push(typeAndParent(context, reflection.implementationOf)); - } - - if (reflection.inheritedFrom) { - md.push(heading(headingLevel, 'Inherited from')); - md.push(typeAndParent(context, reflection.inheritedFrom)); - } - - if (reflection.overwrites) { - md.push(heading(headingLevel, 'Overrides')); - md.push(typeAndParent(context, reflection.overwrites)); - } - - return md.join('\n\n'); -} - -const typeAndParent = ( - context: MarkdownThemeRenderContext, - props: ArrayType | ReferenceType, -) => { - const getUrl = (name: string, url: string) => - link(backTicks(name), context.relativeURL(url)); - - if (props) { - if ('elementType' in props) { - return typeAndParent(context, props.elementType as any) + '[]'; - } else { - if (props.reflection) { - const md: string[] = []; - if (props.reflection instanceof SignatureReflection) { - if (props.reflection.parent?.parent?.url) { - md.push( - getUrl( - props.reflection.parent.parent.name, - props.reflection.parent.parent.url, - ), - ); - if (props.reflection.parent.url) { - md.push( - getUrl( - props.reflection.parent.name, - props.reflection.parent.url, - ), - ); - } - } - } else { - if (props.reflection.parent?.url) { - md.push( - getUrl(props.reflection.parent.name, props.reflection.parent.url), - ); - if (props.reflection.url) { - md.push(getUrl(props.reflection.name, props.reflection.url)); - } - } - } - return md.length > 0 ? md.join('.') : props.name; - } else { - return escapeChars(props.toString()); - } - } - } - return 'void'; -}; diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.kind-tag.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.kind-tag.ts deleted file mode 100644 index 4f39cec7..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.kind-tag.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { DeclarationReflection, ReflectionKind } from 'typedoc'; -import { SYMBOLS_WITH_DOCUMENTS } from '../../support/constants'; -import { backTicks, bold } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function memberKindTag( - context: MarkdownThemeRenderContext, - reflection: DeclarationReflection, -) { - if (reflection.kindOf(SYMBOLS_WITH_DOCUMENTS)) { - return bold(backTicks(ReflectionKind.singularString(reflection.kind))); - } - return ''; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.reference.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.reference.ts deleted file mode 100644 index c18c95d4..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.reference.ts +++ /dev/null @@ -1,21 +0,0 @@ -import { ReferenceReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function referenceMember( - context: MarkdownThemeRenderContext, - props: ReferenceReflection, -) { - const referenced = props.tryGetTargetReflectionDeep(); - - if (!referenced) { - return `Re-exports ${props.name}`; - } - - if (props.name === referenced.name) { - return `Re-exports [${referenced.name}](${context.urlTo(referenced)})`; - } - - return `Renames and re-exports [${referenced.name}](${context.urlTo( - referenced, - )})`; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.reflection.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.reflection.ts deleted file mode 100644 index efe9b32d..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.reflection.ts +++ /dev/null @@ -1,72 +0,0 @@ -import { DeclarationReflection, ReflectionKind } from 'typedoc'; -import { heading, unorderedList } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -/** - * Represents a top level reflection - * @param context - * @param reflection - * @returns - */ -export function reflectionMember( - context: MarkdownThemeRenderContext, - reflection: DeclarationReflection, - headingLevel: number, -) { - const md: string[] = []; - - if (reflection.comment) { - md.push(context.partials.comment(reflection.comment, headingLevel)); - } - - if ( - !reflection.kindOf([ - ReflectionKind.Module, - ReflectionKind.Project, - ReflectionKind.Namespace, - ]) && - reflection.sources - ) { - md.push(context.partials.sources(reflection)); - } - - if (reflection.typeParameters) { - md.push(heading(headingLevel, 'Type parameters')); - md.push(context.partials.typeParametersTable(reflection.typeParameters)); - } - - if (!context.getOption('hideHierarchy') && reflection.typeHierarchy?.next) { - md.push(heading(headingLevel, 'Hierarchy')); - md.push(context.partials.hierarchy(reflection.typeHierarchy)); - } - - if (reflection.implementedTypes) { - md.push(heading(headingLevel, 'Implements')); - md.push( - unorderedList( - reflection.implementedTypes.map((implementedType) => - context.partials.someType(implementedType), - ), - ), - ); - } - - if ('signatures' in reflection && reflection.signatures) { - reflection.signatures.forEach((signature) => { - md.push(context.partials.signatureMember(signature, headingLevel)); - }); - } - - if ('indexSignature' in reflection && reflection.indexSignature) { - md.push(heading(headingLevel, 'Indexable')); - md.push(context.partials.indexSignatureTitle(reflection.indexSignature)); - } - - if (reflection.kindOf([ReflectionKind.Module, ReflectionKind.Namespace])) { - md.push(context.partials.toc(reflection)); - } - - md.push(context.partials.members(reflection, headingLevel)); - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.signature.identifier.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.signature.identifier.ts deleted file mode 100644 index d52f729b..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.signature.identifier.ts +++ /dev/null @@ -1,66 +0,0 @@ -import { ParameterReflection, SignatureReflection, SomeType } from 'typedoc'; -import { backTicks, bold } from '../../support/els'; -import { escapeChars } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function signatureMemberIdentifier( - context: MarkdownThemeRenderContext, - signature: SignatureReflection, -) { - const md: string[] = []; - - if (signature.parent && signature.parent.flags?.length > 0) { - md.push( - signature.parent.flags.map((flag) => `\`${flag}\``).join(' ') + ' ', - ); - } - - if (!['__call', '__type'].includes(signature.name)) { - md.push(bold(escapeChars(signature.name))); - } - - if (signature.typeParameters) { - md.push( - `\\<${signature.typeParameters - .map((typeParameter) => typeParameter.name) - .join(', ')}\\>`, - ); - } - - const getParameters = (parameters: ParameterReflection[] = []) => { - const firstOptionalParamIndex = parameters.findIndex( - (parameter) => parameter.flags.isOptional, - ); - return parameters - .map((param, i) => { - const paramsmd: string[] = [parameters.length > 2 ? '\n ' : '']; - if (param.flags.isRest) { - paramsmd.push('...'); - } - const paramItem = `${escapeChars(param.name)}${ - param.flags.isOptional || - (firstOptionalParamIndex !== -1 && i > firstOptionalParamIndex) - ? '?' - : '' - }: ${context.partials.someType(param.type as SomeType, 'all')}`; - paramsmd.push(paramItem); - if (param.defaultValue) { - paramsmd.push(` = ${backTicks(param.defaultValue)}`); - } - return paramsmd.join(''); - }) - .join(`, `); - }; - - md.push( - signature.parameters && signature.parameters?.length > 0 - ? `(${getParameters(signature.parameters)})` - : '()', - ); - - if (signature.type) { - md.push(`: ${context.partials.someType(signature.type, 'all')}`); - } - - return md.join(''); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.signature.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.signature.ts deleted file mode 100644 index 4d52ff83..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.signature.ts +++ /dev/null @@ -1,73 +0,0 @@ -import { DeclarationReflection, SignatureReflection } from 'typedoc'; -import { blockQuoteBlock, codeBlock, heading } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function signatureMember( - context: MarkdownThemeRenderContext, - signature: SignatureReflection, - headingLevel: number, -) { - const md: string[] = []; - - if (context.getOption('indentifiersAsCodeBlocks')) { - md.push(codeBlock(context.partials.signatureMemberIdentifier(signature))); - } else { - md.push(`> ${context.partials.signatureMemberIdentifier(signature)}`); - } - - if (signature.comment) { - md.push(context.partials.comment(signature.comment, headingLevel)); - } - - if (signature.sources) { - md.push(context.partials.sources(signature)); - } - - const typeDeclaration = (signature.type as any) - ?.declaration as DeclarationReflection; - - if (signature.typeParameters?.length) { - md.push(heading(headingLevel, 'Type parameters')); - md.push(context.partials.typeParametersTable(signature.typeParameters)); - } - - if (signature.parameters?.length) { - md.push(heading(headingLevel, 'Parameters')); - md.push(context.partials.parametersTable(signature.parameters)); - } - - if (signature.type) { - md.push(heading(headingLevel, 'Returns')); - md.push(context.partials.someType(signature.type, 'all')); - - if (signature.comment?.blockTags.length) { - const tags = signature.comment.blockTags - .filter((tag) => tag.tag === '@returns') - .map((tag) => context.partials.commentParts(tag.content)); - md.push(tags.join('\n\n')); - } - - if (typeDeclaration?.signatures) { - typeDeclaration.signatures.forEach((signature) => { - md.push( - blockQuoteBlock( - context.partials.signatureMember(signature, headingLevel + 1), - ), - ); - }); - } - - if (typeDeclaration?.children) { - md.push( - context.partials.typeDeclarationMember( - typeDeclaration, - headingLevel + 1, - ), - ); - } - - md.push(context.partials.inheritance(signature, headingLevel)); - } - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.sources.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.sources.ts deleted file mode 100644 index 4b49a842..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.sources.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { DeclarationReflection, SignatureReflection } from 'typedoc'; -import { bold, link } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -import { escapeChars } from '../../support/utils'; - -export function sources( - context: MarkdownThemeRenderContext, - reflection: DeclarationReflection | SignatureReflection, -) { - const md = [bold('Source:')]; - reflection.sources?.forEach((source) => { - if (source.url) { - md.push( - link(`${escapeChars(source.fileName)}:${source.line}`, source.url), - ); - } else { - md.push(`${escapeChars(source.fileName)}:${source.line}`); - } - }); - return md.join(' '); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.title.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.title.ts deleted file mode 100644 index 6d61e192..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.title.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { DeclarationReflection } from 'typedoc'; -import { backTicks } from '../../support/els'; -import { escapeChars } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function memberTitle( - context: MarkdownThemeRenderContext, - reflection: DeclarationReflection, - typeParams = false, -) { - const md = [escapeChars(reflection.name)]; - if (reflection.signatures?.length) { - md.push('()'); - } - if (typeParams && reflection.typeParameters) { - const typeParameters = reflection.typeParameters - .map((typeParameter) => typeParameter.name) - .join(', '); - md.push(`${backTicks(`<${typeParameters}>`)}`); - } - return md.join(''); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.ts deleted file mode 100644 index b146296a..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.ts +++ /dev/null @@ -1,55 +0,0 @@ -import { - DeclarationReflection, - ReferenceReflection, - ReflectionKind, -} from 'typedoc'; -import { heading } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function member( - context: MarkdownThemeRenderContext, - reflection: DeclarationReflection, - headingLevel: number, -) { - const md: string[] = []; - - if (context.getOption('namedAnchors')) { - md.push(``); - } - - if (!reflection.hasOwnDocument) { - md.push(heading(headingLevel, context.partials.memberTitle(reflection))); - } - - if (!context.getOption('hideKindTag')) { - md.push(context.partials.memberKindTag(reflection)); - } - - if ( - [ - ReflectionKind.Class, - ReflectionKind.Interface, - ReflectionKind.Enum, - ].includes(reflection.kind) - ) { - md.push(context.partials.reflectionMember(reflection, headingLevel + 1)); - } else { - if (reflection.signatures) { - reflection.signatures.forEach((signature) => { - md.push(context.partials.signatureMember(signature, headingLevel + 1)); - }); - } else { - if (reflection instanceof ReferenceReflection) { - md.push(context.partials.referenceMember(reflection)); - } - - if (reflection instanceof DeclarationReflection) { - md.push( - context.partials.declarationMember(reflection, headingLevel + 1), - ); - } - } - } - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/member.type-declaration.ts b/tools/typedoc-plugin-markdown/src/resources/partials/member.type-declaration.ts deleted file mode 100644 index af7b9c9c..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/member.type-declaration.ts +++ /dev/null @@ -1,32 +0,0 @@ -import { DeclarationReflection, ReflectionKind } from 'typedoc'; -import { FormatStyle } from '../../models'; -import { blockQuoteBlock } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function typeDeclarationMember( - context: MarkdownThemeRenderContext, - typeDeclaration: DeclarationReflection, - headingLevel: number, -) { - const md: string[] = []; - if (typeDeclaration.children) { - if (context.getOption('typeDeclarationFormat') === FormatStyle.Table) { - md.push( - context.partials.propertiesTable(typeDeclaration.children, 'Member'), - ); - } else { - const list = typeDeclaration.children.map((declarationChild) => { - return context.partials.declarationMember( - declarationChild, - headingLevel, - ); - }); - if (typeDeclaration?.parent?.kindOf(ReflectionKind.Property)) { - md.push(blockQuoteBlock(list.join('\n'))); - } else { - md.push(list.join('\n')); - } - } - } - return md.join('\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/members.ts b/tools/typedoc-plugin-markdown/src/resources/partials/members.ts deleted file mode 100644 index 5bfd357b..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/members.ts +++ /dev/null @@ -1,96 +0,0 @@ -import { - ContainerReflection, - DeclarationReflection, - ReflectionCategory, - ReflectionKind, -} from 'typedoc'; -import { FormatStyle } from '../../models'; -import { SYMBOLS_WITH_DOCUMENTS } from '../../support/constants'; -import { heading, horizontalRule } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function members( - context: MarkdownThemeRenderContext, - container: ContainerReflection, - headingLevel: number, -) { - const md: string[] = []; - - const pushCategories = ( - categories: ReflectionCategory[], - headingLevel: number, - ) => { - categories - ?.filter((category) => !category.allChildrenHaveOwnDocument()) - .forEach((item) => { - md.push(heading(headingLevel, item.title)); - pushChildren(item.children, headingLevel + 1); - }); - }; - - const pushChildren = ( - children?: DeclarationReflection[], - memberHeadingLevel?: number, - ) => { - children - ?.filter((item) => !item.hasOwnDocument) - .forEach((item) => { - md.push( - context.partials.member(item, memberHeadingLevel || headingLevel), - ); - if (SYMBOLS_WITH_DOCUMENTS.includes(item.kind)) { - md.push(horizontalRule()); - } - }); - }; - - if (container.categories?.length) { - pushCategories(container.categories, headingLevel); - } else { - if ( - context.getOption('excludeGroups') && - container.kindOf([ReflectionKind.Module, ReflectionKind.Namespace]) - ) { - if (container.categories?.length) { - pushCategories(container.categories, headingLevel); - } else { - pushChildren(container.children, headingLevel); - } - } else { - container.groups - ?.filter((group) => !group.allChildrenHaveOwnDocument()) - .forEach((group) => { - if (group.categories) { - md.push(heading(headingLevel, group.title)); - pushCategories(group.categories, headingLevel + 1); - } else { - md.push(heading(headingLevel, group.title)); - - const isPropertiesGroup = group.children.every((child) => - child.kindOf(ReflectionKind.Property), - ); - - const isEnumGroup = group.children.every((child) => - child.kindOf(ReflectionKind.EnumMember), - ); - - if ( - isPropertiesGroup && - context.getOption('propertiesFormat') === FormatStyle.Table - ) { - md.push(context.partials.propertiesTable(group.children)); - } else if ( - isEnumGroup && - context.getOption('enumMembersFormat') === FormatStyle.Table - ) { - md.push(context.partials.enumMembersTable(group.children)); - } else { - pushChildren(group.children, headingLevel + 1); - } - } - }); - } - } - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/navigation.ts b/tools/typedoc-plugin-markdown/src/resources/partials/navigation.ts deleted file mode 100644 index 3adb6131..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/navigation.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { NavigationItem } from '../../models'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function navigation( - context: MarkdownThemeRenderContext, - navigationItems: NavigationItem[], -) { - const title = - context.getOption('entryPoints')?.length > 1 ? 'Modules' : 'Exports'; - const md: string[] = [`## ${title}\n`]; - navigationItems.forEach((navigationItem) => { - if (navigationItem.url) { - md.push( - `- [${navigationItem.title}](${context.parseUrl(navigationItem.url)})`, - ); - } - }); - return md.join('\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/page.header.ts b/tools/typedoc-plugin-markdown/src/resources/partials/page.header.ts deleted file mode 100644 index 0b7e1ced..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/page.header.ts +++ /dev/null @@ -1,97 +0,0 @@ -import * as path from 'path'; -import { - DeclarationReflection, - PageEvent, - ProjectReflection, - ReflectionKind, -} from 'typedoc'; -import { bold, link } from '../../support/els'; -import { getProjectDisplayName } from '../../support/helpers'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function pageHeader( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const isMonoRepo = !Boolean(page.project.groups); - if (isMonoRepo) { - const packageItem = findPackage(page.model); - if (packageItem) { - return packageHeader(context, page); - } - } - return projectHeader(context, page); -} - -function projectHeader( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const projectName = getProjectDisplayName( - page.project, - context.getOption('includeVersion'), - ); - - const hasReadme = !context.getOption('readme').endsWith('none'); - - const md = [ - `${link( - bold(projectName), - context.relativeURL(context.getOption('entryDocument')), - )}`, - ]; - - if (hasReadme) { - md.push( - `(${link( - bold( - page.project.groups - ? context.getOption('entryPoints').length > 1 - ? 'Modules' - : 'Exports' - : 'Packages', - ), - context.relativeURL(page.project.url), - )})`, - ); - } - - return `${md.join(' ')}\n***\n`; -} - -export function packageHeader( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const packageItem = findPackage(page.model); - if (!packageItem) { - return ''; - } - - const hasReadme = Boolean(packageItem.readme); - - const readmeUrl = `${path.dirname(packageItem.url)}/${context.readmeFile}`; - - const md = [ - `${link( - bold(packageItem.name), - context.relativeURL(hasReadme ? readmeUrl : packageItem.url), - )}`, - ]; - - if (hasReadme) { - md.push(`(${link(bold('Exports'), context.relativeURL(packageItem.url))})`); - } - - return `${md.join(' ')}\n***\n`; -} - -function findPackage(model: DeclarationReflection | ProjectReflection) { - if (model.kindOf(ReflectionKind.Module)) { - return model; - } - if (model.parent) { - return findPackage(model.parent as DeclarationReflection); - } - return null; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/page.title.ts b/tools/typedoc-plugin-markdown/src/resources/partials/page.title.ts deleted file mode 100644 index d80cc6a7..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/page.title.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { DeclarationReflection, PageEvent, ProjectReflection } from 'typedoc'; -import { getProjectDisplayName } from '../../support/helpers'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function pageTitle( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const md: string[] = []; - if (page.model?.url === page.project.url) { - md.push( - context.getOption('indexPageTitle') || - getProjectDisplayName( - page.project, - context.getOption('includeVersion'), - ), - ); - } else { - md.push( - context.partials.memberTitle(page.model as DeclarationReflection, true), - ); - } - return md.join(' '); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/table.enum-members.ts b/tools/typedoc-plugin-markdown/src/resources/partials/table.enum-members.ts deleted file mode 100644 index 150ec278..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/table.enum-members.ts +++ /dev/null @@ -1,65 +0,0 @@ -import { DeclarationReflection, ReflectionType } from 'typedoc'; -import { getDeclarationType } from '../../support/helpers'; -import { escapeChars, stripLineBreaks } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function enumMembersTable( - context: MarkdownThemeRenderContext, - props: DeclarationReflection[], -) { - const comments = props.map((param) => !!param.comment?.hasVisibleComponent()); - const hasComments = comments.some((value) => Boolean(value)); - - const headers = ['Member', 'Value']; - - if (hasComments) { - headers.push('Description'); - } - - const rows = props.map((property: DeclarationReflection) => { - const propertyType = getDeclarationType(property); - const row: string[] = []; - row.push(escapeChars(property.name)); - if (propertyType) { - row.push( - stripLineBreaks( - context.partials - .someType(propertyType, 'object') - .replace(/(? ':------') - .join(' | ')} |\n${rows.join('')}`; - - return output; -} - -function getComments(property: DeclarationReflection) { - if (property.type instanceof ReflectionType) { - if (property.type?.declaration?.signatures) { - return property.type?.declaration.signatures[0].comment; - } - } - if (property.signatures) { - return property.signatures[0].comment; - } - return property.comment; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/table.parameters.ts b/tools/typedoc-plugin-markdown/src/resources/partials/table.parameters.ts deleted file mode 100644 index d42893f3..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/table.parameters.ts +++ /dev/null @@ -1,106 +0,0 @@ -import { ParameterReflection, ReflectionKind } from 'typedoc'; - -import { table } from '../../support/els'; -import { tableComments } from '../../support/helpers'; -import { escapeChars, stripLineBreaks } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function parametersTable( - context: MarkdownThemeRenderContext, - parameters: ParameterReflection[], -) { - const flattenParams = (current: any) => { - return current.type?.declaration?.children?.reduce( - (acc: any, child: any) => { - const childObj = { - ...child, - name: `${current.name}.${child.name}`, - }; - return parseParams(childObj, acc); - }, - [], - ); - }; - - const parseParams = (current: any, acc: any) => { - const shouldFlatten = - current.type?.declaration?.kind === ReflectionKind.TypeLiteral && - current.type?.declaration?.children; - return shouldFlatten - ? [...acc, current, ...flattenParams(current)] - : [...acc, current]; - }; - const showDefaults = hasDefaultValues(parameters); - - const comments = parameters.map( - (param) => !!param.comment?.hasVisibleComponent(), - ); - const hasComments = !comments.every((value) => !value); - - const headers = ['Parameter', 'Type']; - - if (showDefaults) { - headers.push('Default value'); - } - - if (hasComments) { - headers.push('Description'); - } - - const firstOptionalParamIndex = parameters.findIndex( - (parameter) => parameter.flags.isOptional, - ); - - const rows: string[][] = []; - - parameters.forEach((parameter, i) => { - const row: string[] = []; - - const isOptional = - parameter.flags.isOptional || - (firstOptionalParamIndex !== -1 && i > firstOptionalParamIndex); - - const rest = parameter.flags.isRest ? '...' : ''; - - const optional = isOptional ? '?' : ''; - - row.push(`${rest}${escapeChars(parameter.name)}${optional}`); - - if (parameter.type) { - row.push( - stripLineBreaks(context.partials.someType(parameter.type, 'object')), - ); - } - - if (showDefaults) { - row.push(getDefaultValue(parameter)); - } - if (hasComments) { - if (parameter.comment) { - row.push(tableComments(context.partials.comment(parameter.comment))); - } else { - row.push('-'); - } - } - rows.push(row); - }); - - return table(headers, rows); -} - -function getDefaultValue(parameter: ParameterReflection) { - return parameter.defaultValue && parameter.defaultValue !== '...' - ? escapeChars(parameter.defaultValue) - : 'undefined'; -} - -function hasDefaultValues(parameters: ParameterReflection[]) { - const defaultValues = (parameters as ParameterReflection[]).map( - (param) => - param.defaultValue !== '{}' && - param.defaultValue !== '...' && - !!param.defaultValue, - ); - - return !defaultValues.every((value) => !value); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/table.properties.ts b/tools/typedoc-plugin-markdown/src/resources/partials/table.properties.ts deleted file mode 100644 index 5266dae0..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/table.properties.ts +++ /dev/null @@ -1,98 +0,0 @@ -import { DeclarationReflection, ReflectionType } from 'typedoc'; -import { backTicks, table } from '../../support/els'; -import { getDeclarationType, tableComments } from '../../support/helpers'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function propertiesTable( - context: MarkdownThemeRenderContext, - props: DeclarationReflection[], - nameCol = 'Property', -) { - const comments = props.map((param) => !!param.comment?.hasVisibleComponent()); - const hasComments = comments.some((value) => Boolean(value)); - - const headers = [nameCol]; - - headers.push('Type'); - - if (hasComments) { - headers.push('Description'); - } - - const flattenParams = (current: any) => { - return current.type?.declaration?.children?.reduce( - (acc: any, child: any) => { - const childObj = { - ...child, - name: `${current.name}.${child.name}`, - }; - return parseParams(childObj, acc); - }, - [], - ); - }; - - const parseParams = (current: any, acc: any) => { - const shouldFlatten = current.type?.declaration?.children; - - return shouldFlatten - ? [...acc, current, ...flattenParams(current)] - : [...acc, current]; - }; - - const properties = props.reduce( - (acc: any, current: any) => parseParams(current, acc), - [], - ); - - const rows: string[][] = []; - - properties.forEach((property: DeclarationReflection) => { - const propertyType = getDeclarationType(property); - const row: string[] = []; - - const nameColumn: string[] = []; - - if (property.flags.length && !property.flags.isOptional) { - nameColumn.push( - property.flags.map((flag) => backTicks(flag.toLowerCase())).join(' '), - ); - } - - nameColumn.push( - `${context.partials.declarationMemberName(property, false)}${ - property.flags.isOptional ? '?' : '' - }`, - ); - - row.push(nameColumn.join(' ')); - - if (propertyType) { - row.push(context.partials.someType(propertyType, 'object')); - } - - if (hasComments) { - const comments = getComments(property); - if (comments) { - row.push(tableComments(context.partials.comment(comments))); - } else { - row.push('-'); - } - } - rows.push(row); - }); - - return table(headers, rows); -} - -function getComments(property: DeclarationReflection) { - if (property.type instanceof ReflectionType) { - if (property.type?.declaration?.signatures) { - return property.type?.declaration.signatures[0].comment; - } - } - if (property.signatures) { - return property.signatures[0].comment; - } - return property.comment; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/table.typeparameters.ts b/tools/typedoc-plugin-markdown/src/resources/partials/table.typeparameters.ts deleted file mode 100644 index f04df4f8..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/table.typeparameters.ts +++ /dev/null @@ -1,65 +0,0 @@ -import { TypeParameterReflection } from 'typedoc'; -import { italic, table } from '../../support/els'; -import { tableComments } from '../../support/helpers'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function typeParametersTable( - context: MarkdownThemeRenderContext, - typeParameters: TypeParameterReflection[], -) { - const hasDefault = typeParameters.some((typeParameter) => - Boolean(typeParameter.default), - ); - - const hasComments = typeParameters.some((typeParameter) => - Boolean(typeParameter.comment), - ); - - const headers = ['Parameter']; - - if (hasDefault) { - headers.push('Default'); - } - - if (hasComments) { - headers.push('Description'); - } - - const rows: string[][] = []; - typeParameters?.forEach((typeParameter) => { - const row: string[] = []; - - const nameCol: string[] = []; - - nameCol.push(typeParameter.name); - - if (typeParameter.type) { - nameCol.push( - `${italic('extends')} ${context.partials.someType(typeParameter.type)}`, - ); - } - - row.push(nameCol.join(' ')); - - if (hasDefault) { - if (typeParameter.default) { - row.push(context.partials.someType(typeParameter.default)); - } else { - row.push('-'); - } - } - - if (hasComments) { - if (typeParameter.comment) { - row.push( - tableComments(context.partials.comment(typeParameter.comment)), - ); - } else { - row.push('-'); - } - } - rows.push(row); - }); - - return table(headers, rows); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/toc.ts b/tools/typedoc-plugin-markdown/src/resources/partials/toc.ts deleted file mode 100644 index a340e2e5..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/toc.ts +++ /dev/null @@ -1,107 +0,0 @@ -import { - DeclarationReflection, - ProjectReflection, - ReflectionGroup, - ReflectionKind, -} from 'typedoc'; -import { backTicks, heading } from '../../support/els'; - -import { escapeChars } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function toc( - context: MarkdownThemeRenderContext, - reflection: ProjectReflection | DeclarationReflection, -) { - const md: string[] = []; - - const hideInPageTOC = context.getOption('hideInPageTOC'); - - const isVisible = reflection.groups?.some((group) => - group.allChildrenHaveOwnDocument(), - ); - - if ( - (!hideInPageTOC && reflection.groups) || - (isVisible && reflection.groups) - ) { - const headingLevel = getIndexHeadingLevel(reflection); - const subHeadingLevel = headingLevel + 1; - - md.push(heading(headingLevel, 'Index\n')); - - if (reflection.categories?.length) { - reflection.categories.forEach((item) => { - md.push(heading(subHeadingLevel, item.title) + '\n'); - md.push(getGroup(context, item) + '\n'); - }); - } else { - if (context.getOption('excludeGroups') && reflection.children) { - md.push( - reflection.children - .map((child) => { - return getTocItem(context, child); - }) - .join('\n'), - ); - } else { - reflection.groups?.forEach((reflectionGroup) => { - if (reflectionGroup.categories) { - md.push(heading(subHeadingLevel, reflectionGroup.title) + '\n'); - reflectionGroup.categories.forEach((item2) => { - md.push(heading(subHeadingLevel + 1, item2.title) + '\n'); - md.push(getGroup(context, reflectionGroup) + '\n'); - }); - } else { - if ( - !hideInPageTOC || - reflectionGroup.allChildrenHaveOwnDocument() - ) { - md.push(heading(subHeadingLevel, reflectionGroup.title) + '\n'); - md.push(getGroup(context, reflectionGroup) + '\n'); - } - } - }); - } - } - } - return md.length > 0 ? md.join('\n') : ''; -} - -function getGroup(context: MarkdownThemeRenderContext, group: ReflectionGroup) { - const children = group.children.map((child) => getTocItem(context, child)); - return children.join('\n'); -} - -function getTocItem( - context: MarkdownThemeRenderContext, - reflection: DeclarationReflection, -) { - const showKindTag = - !reflection.kindOf(ReflectionKind.Module) && - !context.getOption('hideKindTag') && - context.getOption('excludeGroups'); - return `- ${ - showKindTag - ? backTicks( - Array.from(ReflectionKind.singularString(reflection.kind))[0], - ) + ' ' - : '' - }[${escapeChars(reflection.name)}](${context.relativeURL(reflection.url)})`; -} - -function getIndexHeadingLevel( - reflection: DeclarationReflection | ProjectReflection, -) { - if ( - reflection.kindOf([ - ReflectionKind.Project, - ReflectionKind.Module, - ReflectionKind.Namespace, - ]) || - reflection.hasOwnDocument - ) { - return 2; - } - return 4; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.array.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.array.ts deleted file mode 100644 index 658ea38c..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.array.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { ArrayType } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function arrayType( - context: MarkdownThemeRenderContext, - arrayType: ArrayType, -) { - const theType = context.partials.someType(arrayType.elementType, 'none'); - return arrayType.elementType.type === 'union' - ? `(${theType})[]` - : `${theType}[]`; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.conditional.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.conditional.ts deleted file mode 100644 index db39ddac..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.conditional.ts +++ /dev/null @@ -1,26 +0,0 @@ -import { ConditionalType } from 'typedoc'; -import { italic } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function conditionalType( - context: MarkdownThemeRenderContext, - conditionalType: ConditionalType, -) { - const md: string[] = []; - if (conditionalType.checkType) { - md.push(context.partials.someType(conditionalType.checkType)); - } - md.push(italic('extends')); - if (conditionalType.extendsType) { - md.push(context.partials.someType(conditionalType.extendsType)); - } - md.push('?'); - if (conditionalType.trueType) { - md.push(context.partials.someType(conditionalType.trueType)); - } - md.push(':'); - if (conditionalType.falseType) { - md.push(context.partials.someType(conditionalType.falseType)); - } - return md.join(' '); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.declaration.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.declaration.ts deleted file mode 100644 index 755f39e0..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.declaration.ts +++ /dev/null @@ -1,44 +0,0 @@ -import { DeclarationReflection, SomeType } from 'typedoc'; -import { Collapse } from '../../models'; -import { backTicks } from '../../support/els'; -import { getDeclarationType } from '../../support/helpers'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function declarationType( - context: MarkdownThemeRenderContext, - declarationReflection: DeclarationReflection, - collapse: Collapse = 'none', -) { - if (collapse === 'object' || collapse === 'all') { - return backTicks('object'); - } - - if (declarationReflection.indexSignature || declarationReflection.children) { - let indexSignature = ''; - const declarationIndexSignature = declarationReflection.indexSignature; - if (declarationIndexSignature) { - const key = declarationIndexSignature.parameters - ? declarationIndexSignature.parameters.map( - (param) => `\`[${param.name}: ${param.type}]\``, - ) - : ''; - const obj = context.partials.someType( - declarationIndexSignature.type as SomeType, - ); - indexSignature = `${key}: ${obj}; `; - } - const types = - declarationReflection.children && - declarationReflection.children.map((obj) => { - return `${context.partials.declarationMemberName( - obj, - false, - )}: ${context.partials.someType(getDeclarationType(obj) as SomeType)};`; - }); - if (indexSignature) { - types?.unshift(indexSignature); - } - return types ? `\\{${types.join(' ')}}` : '\\{}'; - } - return '\\{}'; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.function.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.function.ts deleted file mode 100644 index 70e39664..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.function.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { SignatureReflection, SomeType } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function functionType( - context: MarkdownThemeRenderContext, - modelSignatures: SignatureReflection[], -) { - const functions = modelSignatures.map((fn) => { - const typeParams = fn.typeParameters - ? `\\<${fn.typeParameters - .map((typeParameter) => typeParameter.name) - .join(', ')}\\>` - : []; - const params = fn.parameters - ? fn.parameters.map((param) => { - return `${param.flags.isRest ? '...' : ''}${param.name}${ - param.flags.isOptional ? '?' : '' - }: ${context.partials.someType(param.type as SomeType)}`; - }) - : []; - const returns = context.partials.someType(fn.type as SomeType); - return typeParams + `(${params.join(', ')}) => ${returns}`; - }); - return functions.join(''); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.index-access.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.index-access.ts deleted file mode 100644 index 24645273..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.index-access.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { IndexedAccessType } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function indexAccessType( - context: MarkdownThemeRenderContext, - model: IndexedAccessType, -) { - const md: string[] = []; - if (model.objectType) { - md.push(context.partials.someType(model.objectType)); - } - if (model.indexType) { - md.push(`[${context.partials.someType(model.indexType)}]`); - } - return md.join(''); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.inferred.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.inferred.ts deleted file mode 100644 index dc8d4287..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.inferred.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { InferredType } from 'typedoc'; -import { escapeChars } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function inferredType( - context: MarkdownThemeRenderContext, - model: InferredType, -) { - return `infer ${escapeChars(model.name)}`; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.intersection.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.intersection.ts deleted file mode 100644 index aec5d043..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.intersection.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { IntersectionType } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function intersectionType( - context: MarkdownThemeRenderContext, - model: IntersectionType, -) { - return model.types - .map((intersectionType) => - context.partials.someType(intersectionType, 'none'), - ) - .join(' & '); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.intrinsic.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.intrinsic.ts deleted file mode 100644 index ec2b0e63..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.intrinsic.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { IntrinsicType } from 'typedoc'; -import { backTicks } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function intrinsicType( - context: MarkdownThemeRenderContext, - model: IntrinsicType, -) { - return backTicks(model.name); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.literal.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.literal.ts deleted file mode 100644 index f518ef27..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.literal.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { LiteralType } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function literalType( - context: MarkdownThemeRenderContext, - literalType: LiteralType, -) { - if (typeof literalType.value === 'bigint') { - return `\`${literalType.value}n\``; - } - return `\`\`${JSON.stringify(literalType.value)}\`\``; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.query.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.query.ts deleted file mode 100644 index 39f822a0..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.query.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { QueryType } from 'typedoc'; -import { italic } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function queryType( - context: MarkdownThemeRenderContext, - queryType: QueryType, -) { - return `${italic('typeof')} ${context.partials.someType( - queryType.queryType, - )}`; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.reference.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.reference.ts deleted file mode 100644 index 82f543ba..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.reference.ts +++ /dev/null @@ -1,40 +0,0 @@ -import { ReferenceType } from 'typedoc'; -import { backTicks } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function referenceType( - context: MarkdownThemeRenderContext, - referenceType: ReferenceType, -) { - if ( - referenceType.reflection || - (referenceType.name && referenceType.typeArguments) - ) { - const reflection: string[] = []; - - if (referenceType.reflection?.url) { - reflection.push( - `[${backTicks(referenceType.reflection.name)}](${context.relativeURL( - referenceType.reflection.url, - )})`, - ); - } else { - reflection.push( - referenceType.externalUrl - ? `[${backTicks(referenceType.name)}]( ${referenceType.externalUrl} )` - : backTicks(referenceType.name), - ); - } - if (referenceType.typeArguments && referenceType.typeArguments.length > 0) { - reflection.push( - `\\<${referenceType.typeArguments - .map((typeArgument) => context.partials.someType(typeArgument)) - .join(', ')}\\>`, - ); - } - return reflection.join(''); - } - return referenceType.externalUrl - ? `[${backTicks(referenceType.name)}]( ${referenceType.externalUrl} )` - : backTicks(referenceType.name); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.reflection.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.reflection.ts deleted file mode 100644 index 9577582a..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.reflection.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { ReflectionType } from 'typedoc'; -import { Collapse } from '../../models'; -import { backTicks } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function reflectionType( - context: MarkdownThemeRenderContext, - reflectionType: ReflectionType, - collapse: Collapse, -) { - const root = - reflectionType instanceof ReflectionType - ? reflectionType.declaration - : reflectionType; - if (root.signatures) { - return collapse === 'function' || collapse === 'all' - ? backTicks('Function') - : context.partials.functionType(root.signatures); - } - return (collapse === 'object' && !root.indexSignature) || collapse === 'all' - ? backTicks('object') - : context.partials.declarationType(root); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.some.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.some.ts deleted file mode 100644 index f5bd8d76..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.some.ts +++ /dev/null @@ -1,88 +0,0 @@ -import { - ArrayType, - ConditionalType, - IndexedAccessType, - InferredType, - IntersectionType, - IntrinsicType, - QueryType, - ReferenceType, - ReflectionType, - SomeType, - TupleType, - TypeOperatorType, - UnionType, - UnknownType, -} from 'typedoc'; -import { Collapse } from '../../models'; -import { backTicks } from '../../support/els'; -import { escapeChars } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function someType( - context: MarkdownThemeRenderContext, - someType: SomeType, - collapse: Collapse = 'none', -) { - if (!someType) { - return ''; - } - - if (someType instanceof ArrayType) { - return '' + context.partials.arrayType(someType); - } - - if (someType instanceof ConditionalType) { - return '' + context.partials.conditionalType(someType); - } - - if (someType instanceof IndexedAccessType) { - return '' + context.partials.indexAccessType(someType); - } - - if (someType instanceof InferredType) { - return '' + context.partials.inferredType(someType); - } - - if (someType instanceof IntersectionType && someType.types) { - return '' + context.partials.intersectionType(someType); - } - - if (someType instanceof IntrinsicType && someType.name) { - return '' + context.partials.intrinsicType(someType); - } - - if (someType instanceof QueryType) { - return '' + context.partials.queryType(someType); - } - - if (someType instanceof ReferenceType) { - return '' + context.partials.referenceType(someType); - } - - if (someType instanceof ReflectionType) { - return '' + context.partials.reflectionType(someType, collapse); - } - - if (someType instanceof TypeOperatorType) { - return '' + context.partials.typeOperatorType(someType); - } - - if (someType instanceof TupleType && someType.elements) { - return '' + context.partials.tupleType(someType); - } - - if (someType instanceof UnionType && someType.types) { - return '' + context.partials.unionType(someType); - } - - if (someType instanceof UnknownType) { - return '' + context.partials.unknownType(someType); - } - - if (someType.toString() == 'null') { - return backTicks('null'); - } - - return escapeChars(someType?.toString()); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.tuple.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.tuple.ts deleted file mode 100644 index cffcb7ac..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.tuple.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { TupleType } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function tupleType( - context: MarkdownThemeRenderContext, - tupleType: TupleType, -) { - return `[${tupleType.elements - .map((element) => context.partials.someType(element)) - .join(', ')}]`; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.type-operator.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.type-operator.ts deleted file mode 100644 index bd299e51..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.type-operator.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { TypeOperatorType } from 'typedoc'; -import { italic } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function typeOperatorType( - context: MarkdownThemeRenderContext, - model: TypeOperatorType, -) { - return `${italic(model.operator)} ${context.partials.someType(model.target)}`; -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.union.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.union.ts deleted file mode 100644 index b09d567a..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.union.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { UnionType } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function unionType( - context: MarkdownThemeRenderContext, - unionType: UnionType, -) { - return unionType.types - .map((unionType) => context.partials.someType(unionType, 'none')) - .join(` \\| `); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/partials/type.unknown.ts b/tools/typedoc-plugin-markdown/src/resources/partials/type.unknown.ts deleted file mode 100644 index b3cde3b8..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/partials/type.unknown.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { UnknownType } from 'typedoc'; -import { backTicks } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function unknownType( - context: MarkdownThemeRenderContext, - model: UnknownType, -) { - return backTicks(model.name); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/resources.ts b/tools/typedoc-plugin-markdown/src/resources/resources.ts deleted file mode 100644 index dd6da94e..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/resources.ts +++ /dev/null @@ -1,189 +0,0 @@ -// THIS FILE IS AUTOGENERATED - DO NOT EDIT DIRECTLY -import { - ArrayType, - ConditionalType, - ContainerReflection, - Comment, - CommentDisplayPart, - DeclarationHierarchy, - DeclarationReflection, - InferredType, - IntersectionType, - IntrinsicType, - IndexedAccessType, - LiteralType, - PageEvent, - ParameterReflection, - ProjectReflection, - QueryType, - ReferenceReflection, - ReferenceType, - ReflectionType, - SignatureReflection, - SomeType, - TupleType, - TypeOperatorType, - TypeParameterReflection, - UnionType, - UnknownType } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../theme-render-context'; -import { Collapse, NavigationItem } from '../models'; -import { memberTemplate } from './templates/member'; -import { projectTemplate } from './templates/project'; -import { readmeTemplate } from './templates/readme'; -import { reflectionTemplate } from './templates/reflection'; -import { breadcrumbs } from './partials/breadcrumbs'; -import { commentParts } from './partials/comment.parts'; -import { comment } from './partials/comment'; -import { hierarchy } from './partials/hierarchy'; -import { declarationMemberIdentifier } from './partials/member.declaration.identifier'; -import { declarationMemberName } from './partials/member.declaration.name'; -import { declarationMember } from './partials/member.declaration'; -import { indexSignatureTitle } from './partials/member.indexsignature.title'; -import { inheritance } from './partials/member.inheritance'; -import { memberKindTag } from './partials/member.kind-tag'; -import { referenceMember } from './partials/member.reference'; -import { reflectionMember } from './partials/member.reflection'; -import { signatureMemberIdentifier } from './partials/member.signature.identifier'; -import { signatureMember } from './partials/member.signature'; -import { sources } from './partials/member.sources'; -import { memberTitle } from './partials/member.title'; -import { member } from './partials/member'; -import { typeDeclarationMember } from './partials/member.type-declaration'; -import { members } from './partials/members'; -import { navigation } from './partials/navigation'; -import { pageHeader } from './partials/page.header'; -import { pageTitle } from './partials/page.title'; -import { enumMembersTable } from './partials/table.enum-members'; -import { parametersTable } from './partials/table.parameters'; -import { propertiesTable } from './partials/table.properties'; -import { typeParametersTable } from './partials/table.typeparameters'; -import { toc } from './partials/toc'; -import { arrayType } from './partials/type.array'; -import { conditionalType } from './partials/type.conditional'; -import { declarationType } from './partials/type.declaration'; -import { functionType } from './partials/type.function'; -import { indexAccessType } from './partials/type.index-access'; -import { inferredType } from './partials/type.inferred'; -import { intersectionType } from './partials/type.intersection'; -import { intrinsicType } from './partials/type.intrinsic'; -import { literalType } from './partials/type.literal'; -import { queryType } from './partials/type.query'; -import { referenceType } from './partials/type.reference'; -import { reflectionType } from './partials/type.reflection'; -import { someType } from './partials/type.some'; -import { tupleType } from './partials/type.tuple'; -import { typeOperatorType } from './partials/type.type-operator'; -import { unionType } from './partials/type.union'; -import { unknownType } from './partials/type.unknown'; - -function bind(fn: (f: F, ...a: L) => R, first: F) { - return (...r: L) => fn(first, ...r); -} -export type Templates = { - memberTemplate: (page: PageEvent) => string; - projectTemplate: (page: PageEvent) => string; - readmeTemplate: (page: PageEvent) => string; - reflectionTemplate: (page: PageEvent) => string; -}; - -export type Partials = { - breadcrumbs: (page: PageEvent) => string; - commentParts: (parts: CommentDisplayPart[]) => string; - comment: (comment: Comment, headingLevel?: number | undefined) => string; - hierarchy: (declarationHierarchy: DeclarationHierarchy) => string; - declarationMemberIdentifier: (reflection: DeclarationReflection) => string; - declarationMemberName: (declaration: DeclarationReflection, emphasis?: boolean) => string; - declarationMember: (declaration: DeclarationReflection, headingLevel: number) => string; - indexSignatureTitle: (signature: SignatureReflection) => string; - inheritance: (reflection: DeclarationReflection | SignatureReflection, headingLevel: number) => string; - memberKindTag: (reflection: DeclarationReflection) => string; - referenceMember: (props: ReferenceReflection) => string; - reflectionMember: (reflection: DeclarationReflection, headingLevel: number) => string; - signatureMemberIdentifier: (signature: SignatureReflection) => string; - signatureMember: (signature: SignatureReflection, headingLevel: number) => string; - sources: (reflection: DeclarationReflection | SignatureReflection) => string; - memberTitle: (reflection: DeclarationReflection, typeParams?: boolean) => string; - member: (reflection: DeclarationReflection, headingLevel: number) => string; - typeDeclarationMember: (typeDeclaration: DeclarationReflection, headingLevel: number) => string; - members: (container: ContainerReflection, headingLevel: number) => string; - navigation: (navigationItems: NavigationItem[]) => string; - pageHeader: (page: PageEvent) => string; - pageTitle: (page: PageEvent) => string; - enumMembersTable: (props: DeclarationReflection[]) => string; - parametersTable: (parameters: ParameterReflection[]) => string; - propertiesTable: (props: DeclarationReflection[], nameCol?: string) => string; - typeParametersTable: (typeParameters: TypeParameterReflection[]) => string; - toc: (reflection: DeclarationReflection | ProjectReflection) => string; - arrayType: (arrayType: ArrayType) => string; - conditionalType: (conditionalType: ConditionalType) => string; - declarationType: (declarationReflection: DeclarationReflection, collapse?: Collapse) => string; - functionType: (modelSignatures: SignatureReflection[]) => string; - indexAccessType: (model: IndexedAccessType) => string; - inferredType: (model: InferredType) => string; - intersectionType: (model: IntersectionType) => string; - intrinsicType: (model: IntrinsicType) => string; - literalType: (literalType: LiteralType) => string; - queryType: (queryType: QueryType) => string; - referenceType: (referenceType: ReferenceType) => string; - reflectionType: (reflectionType: ReflectionType, collapse: Collapse) => string; - someType: (someType: SomeType, collapse?: Collapse) => string; - tupleType: (tupleType: TupleType) => string; - typeOperatorType: (model: TypeOperatorType) => string; - unionType: (unionType: UnionType) => string; - unknownType: (model: UnknownType) => string; -}; - -export const templates = (context: MarkdownThemeRenderContext): Templates => ({ - memberTemplate: bind(memberTemplate, context), - projectTemplate: bind(projectTemplate, context), - readmeTemplate: bind(readmeTemplate, context), - reflectionTemplate: bind(reflectionTemplate, context), -}); - -export const partials = (context: MarkdownThemeRenderContext): Partials => ({ - breadcrumbs: bind(breadcrumbs, context), - commentParts: bind(commentParts, context), - comment: bind(comment, context), - hierarchy: bind(hierarchy, context), - declarationMemberIdentifier: bind(declarationMemberIdentifier, context), - declarationMemberName: bind(declarationMemberName, context), - declarationMember: bind(declarationMember, context), - indexSignatureTitle: bind(indexSignatureTitle, context), - inheritance: bind(inheritance, context), - memberKindTag: bind(memberKindTag, context), - referenceMember: bind(referenceMember, context), - reflectionMember: bind(reflectionMember, context), - signatureMemberIdentifier: bind(signatureMemberIdentifier, context), - signatureMember: bind(signatureMember, context), - sources: bind(sources, context), - memberTitle: bind(memberTitle, context), - member: bind(member, context), - typeDeclarationMember: bind(typeDeclarationMember, context), - members: bind(members, context), - navigation: bind(navigation, context), - pageHeader: bind(pageHeader, context), - pageTitle: bind(pageTitle, context), - enumMembersTable: bind(enumMembersTable, context), - parametersTable: bind(parametersTable, context), - propertiesTable: bind(propertiesTable, context), - typeParametersTable: bind(typeParametersTable, context), - toc: bind(toc, context), - arrayType: bind(arrayType, context), - conditionalType: bind(conditionalType, context), - declarationType: bind(declarationType, context), - functionType: bind(functionType, context), - indexAccessType: bind(indexAccessType, context), - inferredType: bind(inferredType, context), - intersectionType: bind(intersectionType, context), - intrinsicType: bind(intrinsicType, context), - literalType: bind(literalType, context), - queryType: bind(queryType, context), - referenceType: bind(referenceType, context), - reflectionType: bind(reflectionType, context), - someType: bind(someType, context), - tupleType: bind(tupleType, context), - typeOperatorType: bind(typeOperatorType, context), - unionType: bind(unionType, context), - unknownType: bind(unknownType, context), -}); diff --git a/tools/typedoc-plugin-markdown/src/resources/templates/member.ts b/tools/typedoc-plugin-markdown/src/resources/templates/member.ts deleted file mode 100644 index 9ea2c1c2..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/templates/member.ts +++ /dev/null @@ -1,26 +0,0 @@ -import { DeclarationReflection, PageEvent } from 'typedoc'; -import { heading } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function memberTemplate( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const md: string[] = []; - - if (!context.getOption('hidePageHeader')) { - md.push(context.partials.pageHeader(page)); - } - - if (!context.getOption('hideBreadcrumbs')) { - md.push(context.partials.breadcrumbs(page)); - } - - if (!context.getOption('hidePageTitle')) { - md.push(heading(1, context.partials.pageTitle(page))); - } - - md.push(context.partials.member(page.model, 1)); - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/templates/project.ts b/tools/typedoc-plugin-markdown/src/resources/templates/project.ts deleted file mode 100644 index 8930497e..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/templates/project.ts +++ /dev/null @@ -1,47 +0,0 @@ -import * as path from 'path'; -import { PageEvent, ProjectReflection } from 'typedoc'; -import { heading } from '../../support/els'; -import { escapeChars } from '../../support/utils'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function projectTemplate( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const md: string[] = []; - - if (!context.getOption('hidePageHeader')) { - md.push(context.partials.pageHeader(page)); - } - - if (!context.getOption('hideBreadcrumbs')) { - md.push(context.partials.breadcrumbs(page)); - } - - if (!context.getOption('hidePageTitle')) { - md.push(heading(1, context.partials.pageTitle(page))); - } - - if (page.model.comment) { - md.push(context.partials.comment(page.model.comment, 2)); - } - - if (page.model.groups) { - md.push(context.partials.toc(page.model)); - } else { - md.push(heading(2, 'Packages')); - - const packagesList = page.model.children?.map((projectPackage) => { - return `- [${escapeChars(projectPackage.name)}](${context.relativeURL( - Boolean(projectPackage.readme) - ? `${path.dirname(projectPackage.url || '')}/${context.readmeFile}` - : projectPackage.url, - )})`; - }); - md.push(packagesList?.join('\n') || ''); - } - - md.push(context.partials.members(page.model, 2)); - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/templates/readme.ts b/tools/typedoc-plugin-markdown/src/resources/templates/readme.ts deleted file mode 100644 index b7e9811b..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/templates/readme.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { DeclarationReflection, PageEvent, ProjectReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function readmeTemplate( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const md: string[] = []; - - if (!context.getOption('hidePageHeader')) { - md.push(context.partials.pageHeader(page)); - } - - if (page.model.readme) { - md.push(context.partials.commentParts(page.model.readme)); - } - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/resources/templates/reflection.ts b/tools/typedoc-plugin-markdown/src/resources/templates/reflection.ts deleted file mode 100644 index 65485bc0..00000000 --- a/tools/typedoc-plugin-markdown/src/resources/templates/reflection.ts +++ /dev/null @@ -1,30 +0,0 @@ -import { DeclarationReflection, PageEvent } from 'typedoc'; -import { heading } from '../../support/els'; -import { MarkdownThemeRenderContext } from '../../theme-render-context'; - -export function reflectionTemplate( - context: MarkdownThemeRenderContext, - page: PageEvent, -) { - const md: string[] = []; - - if (!context.getOption('hidePageHeader')) { - md.push(context.partials.pageHeader(page)); - } - - if (!context.getOption('hideBreadcrumbs')) { - md.push(context.partials.breadcrumbs(page)); - } - - if (!context.getOption('hidePageTitle')) { - md.push(heading(1, context.partials.pageTitle(page))); - } - - if (!context.getOption('hideKindTag')) { - md.push(context.partials.memberKindTag(page.model)); - } - - md.push(context.partials.reflectionMember(page.model, 2)); - - return md.join('\n\n'); -} diff --git a/tools/typedoc-plugin-markdown/src/support/constants.ts b/tools/typedoc-plugin-markdown/src/support/constants.ts deleted file mode 100644 index b3f934f2..00000000 --- a/tools/typedoc-plugin-markdown/src/support/constants.ts +++ /dev/null @@ -1,21 +0,0 @@ -import { ReflectionKind } from 'typedoc'; - -export const URL_PREFIX = /^(http|ftp)s?:\/\//; - -export const SYMBOLS_WITH_DOCUMENTS = [ - ReflectionKind.Class, - ReflectionKind.Interface, - ReflectionKind.Enum, - ReflectionKind.Function, - ReflectionKind.Variable, - ReflectionKind.TypeAlias, -]; - -export const VALID_KINDS_WITH_OWN_FILE: string[] = [ - ReflectionKind[ReflectionKind.Class], - ReflectionKind[ReflectionKind.Interface], - ReflectionKind[ReflectionKind.Enum], - ReflectionKind[ReflectionKind.Function], - ReflectionKind[ReflectionKind.TypeAlias], - ReflectionKind[ReflectionKind.Variable], -]; diff --git a/tools/typedoc-plugin-markdown/src/support/els.ts b/tools/typedoc-plugin-markdown/src/support/els.ts deleted file mode 100644 index a88e2ae8..00000000 --- a/tools/typedoc-plugin-markdown/src/support/els.ts +++ /dev/null @@ -1,43 +0,0 @@ -import { unEscapeChars } from './utils'; - -export const heading = (level: number, text: string) => { - level = level > 6 ? 6 : level; - return `${[...Array(level)].map(() => '#').join('')} ${text}`; -}; - -export const link = (label: string, url: string | null) => - url ? `[${label}](${url})` : ''; - -export const bold = (text: string) => `**${text}**`; - -export const italic = (text: string) => `*${text}*`; - -export const backTicks = (text: string) => `\`${text}\``; - -export const unorderedList = (items: T[]) => - items.map((item) => `- ${item}`).join('\n'); - -export const horizontalRule = () => '\n\n---'; - -export const codeBlock = (content: string) => - '```ts\n' + unEscapeChars(content) + '\n```'; - -export const table = (headers: string[], rows: string[][]) => - `\n| ${headers.join(' | ')} |\n| ${headers - .map(() => ':------') - .join(' | ')} |\n${rows.map((row) => `| ${row.join(' | ')} |\n`).join('')}`; - -export const blockQuoteBlock = (content: string) => { - const lines = content.split('\n'); - return lines - .map((line) => (line.length ? `> ${line.trim()}` : '>')) - .join('\n'); -}; - -export const indentBlock = (content: string) => { - const lines = content.split('\n'); - return lines - .filter((line) => Boolean(line.length)) - .map((line) => ` ${line}`) - .join('\n'); -}; diff --git a/tools/typedoc-plugin-markdown/src/support/helpers.ts b/tools/typedoc-plugin-markdown/src/support/helpers.ts deleted file mode 100644 index dd3b1482..00000000 --- a/tools/typedoc-plugin-markdown/src/support/helpers.ts +++ /dev/null @@ -1,46 +0,0 @@ -import { CommentTag, DeclarationReflection, ProjectReflection } from 'typedoc'; -import { backTicks } from './els'; -import { stripLineBreaks } from './utils'; - -export function getTypeParameters(reflection: DeclarationReflection) { - if (reflection.typeParameters) { - const typeParameters = reflection.typeParameters - .map((typeParameter) => typeParameter.name) - .join(', '); - return `\\<${typeParameters}\\>`; - } - return ''; -} - -export function getFlags(reflection: DeclarationReflection) { - if (reflection.flags?.length > 0 && !reflection.flags.isRest) { - return reflection.flags.map((flag) => backTicks(flag)).join(' '); - } - return null; -} - -export function tableComments(str: string) { - return stripLineBreaks(str).replace(/\|/g, '\\|'); -} - -export function getTagName(tag: CommentTag) { - return tag.tag.substring(1); -} - -export function getDeclarationType(declaration: DeclarationReflection) { - if (declaration.getSignature) { - return declaration.getSignature.type; - } - if (declaration.setSignature) { - return declaration.setSignature.type; - } - return declaration.type; -} - -export function getProjectDisplayName( - project: ProjectReflection, - includeVersion: boolean, -): string { - const version = includeVersion ? ` - v${project.packageVersion}` : ''; - return `${project.name}${version}`; -} diff --git a/tools/typedoc-plugin-markdown/src/support/utils.ts b/tools/typedoc-plugin-markdown/src/support/utils.ts deleted file mode 100644 index 8d21314f..00000000 --- a/tools/typedoc-plugin-markdown/src/support/utils.ts +++ /dev/null @@ -1,58 +0,0 @@ -export function escapeChars(str: string) { - return str - .replace(/>/g, '\\>') - .replace(/(?=(?:[^`]*`[^`]*`)*[^`]*$)/gi, '\\>'); -} - -export function escapeTableCol(str: string) { - return str.replace(/(?/g, '>') - .replace(/\\_/g, '_') - .replace(/\\{/g, '{') - .replace(/`/g, '') - .replace(/\*/g, '') - .replace(/\\\|/g, '|') - .replace(/\[([^\[\]]*)\]\((.*?)\)/gm, '$1'); -} - -export function stripComments(str: string) { - return str - .replace(/(?:\/\*(?:[\s\S]*?)\*\/)|(?:^\s*\/\/(?:.*)$)/g, ' ') - .replace(/\n/g, '') - .replace(/^\s+|\s+$|(\s)+/g, '$1'); -} - -export function stripLineBreaks(str: string, includeHTML = true) { - return str ? str.replace(/\n/g, includeHTML ? '
' : ' ').trim() : ''; -} - -export function camelToTitleCase(text: string) { - return ( - text.substring(0, 1).toUpperCase() + - text.substring(1).replace(/[a-z][A-Z]/g, (x) => `${x[0]} ${x[1]}`) - ); -} - -export function slugify(str: string) { - return str - .toLowerCase() - .trim() - .replace(/[^\w\s-]/g, '') - .replace(/[\s_-]+/g, '-') - .replace(/^-+|-+$/g, ''); -} diff --git a/tools/typedoc-plugin-markdown/src/theme-render-context.ts b/tools/typedoc-plugin-markdown/src/theme-render-context.ts deleted file mode 100644 index aba94885..00000000 --- a/tools/typedoc-plugin-markdown/src/theme-render-context.ts +++ /dev/null @@ -1,66 +0,0 @@ -import * as path from 'path'; -import { Options, Reflection } from 'typedoc'; -import { TypedocPluginMarkdownOptions } from './models'; -import { partials, templates } from './resources/resources'; -import { URL_PREFIX } from './support/constants'; -import { MarkdownTheme } from './theme'; - -export class MarkdownThemeRenderContext { - public readmeFile = 'README.md'; - public indexFile = 'index.md'; - public modulesFile = 'modules.md'; - public exportsFile = 'exports.md'; - - private _activeLocation = '.'; - - set activeLocation(activeLocation: string) { - this._activeLocation = activeLocation; - } - - get activeLocation() { - return this._activeLocation; - } - - constructor(public theme: MarkdownTheme, public options: Options) {} - - getOption(name: K) { - return this.options.getValue(name) as TypedocPluginMarkdownOptions[K]; - } - - getRelativeUrl(url: string | undefined) { - if (!url) { - return null; - } - if (URL_PREFIX.test(url)) { - return url; - } else { - if (this.getOption('baseUrl')) { - return this.getOption('baseUrl') + url.replace(/\\/g, '/'); - } - - const relative = path.relative( - path.dirname(this.activeLocation), - path.dirname(url), - ); - - return this.parseUrl( - path.join(relative, path.basename(url)).replace(/\\/g, '/'), - ); - } - } - - urlTo(reflection: Reflection) { - return this.relativeURL(reflection.url); - } - - parseUrl(url: string) { - return encodeURI(url); - } - - relativeURL(url: string | undefined) { - return this.getRelativeUrl(url); - } - - templates = templates(this); - partials = partials(this); -} diff --git a/tools/typedoc-plugin-markdown/src/theme.ts b/tools/typedoc-plugin-markdown/src/theme.ts deleted file mode 100644 index d01efd02..00000000 --- a/tools/typedoc-plugin-markdown/src/theme.ts +++ /dev/null @@ -1,80 +0,0 @@ -import * as prettier from 'prettier'; -import { - PageEvent, - ProjectReflection, - Reflection, - RenderTemplate, - Renderer, - Theme, -} from 'typedoc'; -import { NavigationBuilder } from './converter/navigation-builder'; -import { UrlBuilder } from './converter/url-builder'; -import { MarkdownThemeRenderContext } from './theme-render-context'; - -export class MarkdownTheme extends Theme { - private _renderContext: MarkdownThemeRenderContext; - private _prettierOptions: prettier.Options | null; - - constructor(renderer: Renderer) { - super(renderer); - - // Warnings - if (this.application.options.getValue('enableFrontmatter')) { - this.application.logger.warn( - '[typedoc-plugin-markdown] `enableFrontmatter` has been removed. Please use plugin-typedoc-frontmatter instead', - ); - } - - this.listenTo(this.owner, { - [PageEvent.BEGIN]: this.onBeginPage, - }); - } - - getRenderContext() { - if (!this._renderContext) { - this._renderContext = new MarkdownThemeRenderContext( - this, - this.application.options, - ); - } - return this._renderContext; - } - - getPrettierOptions() { - if (!this._prettierOptions) { - this._prettierOptions = this.resolvePrettierOptions(); - } - return this._prettierOptions; - } - - resolvePrettierOptions() { - const prettierFile = prettier.resolveConfigFile.sync(); - return prettierFile ? prettier.resolveConfig.sync(prettierFile) : null; - } - - render( - page: PageEvent, - template: RenderTemplate>, - ): string { - return prettier.format(template(page) as string, { - ...this.getPrettierOptions(), - parser: 'markdown', - }); - } - - getUrls(project: ProjectReflection) { - const urls = new UrlBuilder(this.getRenderContext()).getUrls(project); - return urls; - } - - getNavigation(project: ProjectReflection) { - const navigation = new NavigationBuilder( - this.getRenderContext(), - ).getNavigation(project); - return navigation; - } - - protected onBeginPage(page: PageEvent) { - this.getRenderContext().activeLocation = page.url; - } -} diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/breadcrumbs.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/breadcrumbs.spec.ts.snap deleted file mode 100644 index ae47de1d..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/breadcrumbs.spec.ts.snap +++ /dev/null @@ -1,11 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Breadcrumbs: (with readme) should compile class breadcrumbs' 1`] = `"[Exports](exports.md) > Breadcrumbs"`; - -exports[`Breadcrumbs: (with readme) should compile entryPoint (globals) breadcrumbs' 1`] = `"[Exports](exports.md) > typedoc-plugin-markdown"`; - -exports[`Breadcrumbs: (with readme) should compile module breadcrumbs' 1`] = `"[Exports](exports.md) > Breadcrumbs"`; - -exports[`Breadcrumbs: (without readme) should compile class breadcrumbs' 1`] = `"[Exports](README.md) > Breadcrumbs"`; - -exports[`Breadcrumbs: (without readme) should compile module breadcrumbs' 1`] = `"[Exports](README.md) > Breadcrumbs"`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/categories.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/categories.spec.ts.snap deleted file mode 100644 index 07e900b1..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/categories.spec.ts.snap +++ /dev/null @@ -1,507 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Categories: (categorizeByGroup=false) should render category TOC' 1`] = ` -"## Index - -### CategoryA - -- [CategoryInterfaceA1](exports.md#categoryinterfacea1) -- [CategoryInterfaceA2](exports.md#categoryinterfacea2) -- [categoryVariableA1](exports.md#categoryvariablea1) -- [categoryVariableA2](exports.md#categoryvariablea2) -- [categoryFunctionA1](exports.md#categoryfunctiona1) -- [categoryFunctionA2](exports.md#categoryfunctiona2) -- [categoryFunctionA3](exports.md#categoryfunctiona3) - -### CategoryB - -- [categoryVariableB1](exports.md#categoryvariableb1) -- [categoryFunctionB2](exports.md#categoryfunctionb2) - -### Other - -- [OtherInterfaceA](exports.md#otherinterfacea) -- [otherVariableA](exports.md#othervariablea) -- [otherVariableB](exports.md#othervariableb) -- [otherFunctionA](exports.md#otherfunctiona) -- [otherFunctionB](exports.md#otherfunctionb) -" -`; - -exports[`Categories: (categorizeByGroup=false) should render category members' 1`] = ` -"## CategoryA - -### CategoryInterfaceA1 - -[partial: reflectionMember] - - - ---- - -### CategoryInterfaceA2 - -[partial: reflectionMember] - - - ---- - -### categoryVariableA1 - -[partial: declarationMember] - - - ---- - -### categoryVariableA2 - -[partial: declarationMember] - - - ---- - -### categoryFunctionA1() - -[partial: signatureMember] - - - ---- - -### categoryFunctionA2() - -[partial: signatureMember] - - - ---- - -### categoryFunctionA3() - -[partial: signatureMember] - - - ---- - -## CategoryB - -### categoryVariableB1 - -[partial: declarationMember] - - - ---- - -### categoryFunctionB2() - -[partial: signatureMember] - - - ---- - -## Other - -### OtherInterfaceA - -[partial: reflectionMember] - - - ---- - -### otherVariableA - -[partial: declarationMember] - - - ---- - -### otherVariableB - -[partial: declarationMember] - - - ---- - -### otherFunctionA() - -[partial: signatureMember] - - - ---- - -### otherFunctionB() - -[partial: signatureMember] - - - ----" -`; - -exports[`Categories: (excludeGroups=false) should render category TOC' 1`] = ` -"## Index - -### Interfaces - -#### CategoryA - -- [CategoryInterfaceA1](exports.md#categoryinterfacea1) -- [CategoryInterfaceA2](exports.md#categoryinterfacea2) -- [OtherInterfaceA](exports.md#otherinterfacea) - -#### Other - -- [CategoryInterfaceA1](exports.md#categoryinterfacea1) -- [CategoryInterfaceA2](exports.md#categoryinterfacea2) -- [OtherInterfaceA](exports.md#otherinterfacea) - -### Variables - -#### CategoryA - -- [categoryVariableA1](exports.md#categoryvariablea1) -- [categoryVariableA2](exports.md#categoryvariablea2) -- [categoryVariableB1](exports.md#categoryvariableb1) -- [otherVariableA](exports.md#othervariablea) -- [otherVariableB](exports.md#othervariableb) - -#### CategoryB - -- [categoryVariableA1](exports.md#categoryvariablea1) -- [categoryVariableA2](exports.md#categoryvariablea2) -- [categoryVariableB1](exports.md#categoryvariableb1) -- [otherVariableA](exports.md#othervariablea) -- [otherVariableB](exports.md#othervariableb) - -#### Other - -- [categoryVariableA1](exports.md#categoryvariablea1) -- [categoryVariableA2](exports.md#categoryvariablea2) -- [categoryVariableB1](exports.md#categoryvariableb1) -- [otherVariableA](exports.md#othervariablea) -- [otherVariableB](exports.md#othervariableb) - -### Functions - -#### CategoryA - -- [categoryFunctionA1](exports.md#categoryfunctiona1) -- [categoryFunctionA2](exports.md#categoryfunctiona2) -- [categoryFunctionA3](exports.md#categoryfunctiona3) -- [categoryFunctionB2](exports.md#categoryfunctionb2) -- [otherFunctionA](exports.md#otherfunctiona) -- [otherFunctionB](exports.md#otherfunctionb) - -#### CategoryB - -- [categoryFunctionA1](exports.md#categoryfunctiona1) -- [categoryFunctionA2](exports.md#categoryfunctiona2) -- [categoryFunctionA3](exports.md#categoryfunctiona3) -- [categoryFunctionB2](exports.md#categoryfunctionb2) -- [otherFunctionA](exports.md#otherfunctiona) -- [otherFunctionB](exports.md#otherfunctionb) - -#### Other - -- [categoryFunctionA1](exports.md#categoryfunctiona1) -- [categoryFunctionA2](exports.md#categoryfunctiona2) -- [categoryFunctionA3](exports.md#categoryfunctiona3) -- [categoryFunctionB2](exports.md#categoryfunctionb2) -- [otherFunctionA](exports.md#otherfunctiona) -- [otherFunctionB](exports.md#otherfunctionb) -" -`; - -exports[`Categories: (excludeGroups=false) should render category members' 1`] = ` -"## Interfaces - -### CategoryA - -#### CategoryInterfaceA1 - -[partial: reflectionMember] - - - ---- - -#### CategoryInterfaceA2 - -[partial: reflectionMember] - - - ---- - -### Other - -#### OtherInterfaceA - -[partial: reflectionMember] - - - ---- - -## Variables - -### CategoryA - -#### categoryVariableA1 - -[partial: declarationMember] - - - ---- - -#### categoryVariableA2 - -[partial: declarationMember] - - - ---- - -### CategoryB - -#### categoryVariableB1 - -[partial: declarationMember] - - - ---- - -### Other - -#### otherVariableA - -[partial: declarationMember] - - - ---- - -#### otherVariableB - -[partial: declarationMember] - - - ---- - -## Functions - -### CategoryA - -#### categoryFunctionA1() - -[partial: signatureMember] - - - ---- - -#### categoryFunctionA2() - -[partial: signatureMember] - - - ---- - -#### categoryFunctionA3() - -[partial: signatureMember] - - - ---- - -### CategoryB - -#### categoryFunctionB2() - -[partial: signatureMember] - - - ---- - -### Other - -#### otherFunctionA() - -[partial: signatureMember] - - - ---- - -#### otherFunctionB() - -[partial: signatureMember] - - - ----" -`; - -exports[`Categories: (excludeGroups=true) should render category TOC' 1`] = ` -"## Index - -### CategoryA - -- [CategoryInterfaceA1](exports.md#categoryinterfacea1) -- [CategoryInterfaceA2](exports.md#categoryinterfacea2) -- [categoryVariableA1](exports.md#categoryvariablea1) -- [categoryVariableA2](exports.md#categoryvariablea2) -- [categoryFunctionA1](exports.md#categoryfunctiona1) -- [categoryFunctionA2](exports.md#categoryfunctiona2) -- [categoryFunctionA3](exports.md#categoryfunctiona3) - -### CategoryB - -- [categoryVariableB1](exports.md#categoryvariableb1) -- [categoryFunctionB2](exports.md#categoryfunctionb2) - -### Other - -- [OtherInterfaceA](exports.md#otherinterfacea) -- [otherVariableA](exports.md#othervariablea) -- [otherVariableB](exports.md#othervariableb) -- [otherFunctionA](exports.md#otherfunctiona) -- [otherFunctionB](exports.md#otherfunctionb) -" -`; - -exports[`Categories: (excludeGroups=true) should render category members' 1`] = ` -"## CategoryA - -### CategoryInterfaceA1 - -[partial: reflectionMember] - - - ---- - -### CategoryInterfaceA2 - -[partial: reflectionMember] - - - ---- - -### categoryVariableA1 - -[partial: declarationMember] - - - ---- - -### categoryVariableA2 - -[partial: declarationMember] - - - ---- - -### categoryFunctionA1() - -[partial: signatureMember] - - - ---- - -### categoryFunctionA2() - -[partial: signatureMember] - - - ---- - -### categoryFunctionA3() - -[partial: signatureMember] - - - ---- - -## CategoryB - -### categoryVariableB1 - -[partial: declarationMember] - - - ---- - -### categoryFunctionB2() - -[partial: signatureMember] - - - ---- - -## Other - -### OtherInterfaceA - -[partial: reflectionMember] - - - ---- - -### otherVariableA - -[partial: declarationMember] - - - ---- - -### otherVariableB - -[partial: declarationMember] - - - ---- - -### otherFunctionA() - -[partial: signatureMember] - - - ---- - -### otherFunctionB() - -[partial: signatureMember] - - - ----" -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap deleted file mode 100644 index f8d91524..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap +++ /dev/null @@ -1,52 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Comments: should convert comments with fenced block' 1`] = ` -"Some comments with fence blocks - -\`\`\`typescript -someFunction() -\`\`\` - -\`\`\`js -anotherFunction() -\`\`\`" -`; - -exports[`Comments: should convert comments with tags' 1`] = ` -"\`Description\` - -Tag description on new line - -- Tag description on another line - -\`Deprecated\` - -Another tag description - -Gets the application version. - -\`Example\` - -\`\`\`typescript -import { getVersion } from '@tauri-apps/api/app'; -const appVersion = await getVersion(); -\`\`\`" -`; - -exports[`Comments: should convert symbols brackets to symbol links' 1`] = ` -"See [\`CommentClass\`](classes/class.CommentClass.md) and CommentClass's [comment](classes/class.CommentClass.md#comment) property. -Also, check out [Google](https://www.google.com) and -[GitHub](https://github.com). - -Taken from [JsDoc](http://usejsdoc.org/tags-inline-link.html)." -`; - -exports[`Comments: should escape angle brackets inside comments' 1`] = ` -"A \\\\ in comments - -A \`\` in backticks - -\`\`\`html -A in a code block -\`\`\`" -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/declarations.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/declarations.spec.ts.snap deleted file mode 100644 index a0e38dcb..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/declarations.spec.ts.snap +++ /dev/null @@ -1,379 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Declarations: should compile a const with default value 1`] = ` -"> \`const\` **stringConstWithDefaultValue**: "hello" = \`'hello'\` - -[partial: sources] - -" -`; - -exports[`Declarations: should compile a let with default value 1`] = ` -"> \`let\` **stringLetWithDefaultValue**: \`string\` = \`'hello'\` - -[partial: sources] - -" -`; - -exports[`Declarations: should compile an undefined declaration 1`] = ` -"> \`let\` **undefinedNumberDeclaration**: \`number\` - -[partial: sources] - -" -`; - -exports[`Declarations: should compile any function type 1`] = ` -"> **AnyFunctionType**: \\<\`A\`\\> \`Function\` - -[partial: sources] - -## Type parameters - - -| Parameter | Default | -| :------ | :------ | -| A | \`any\` | - - -## Type declaration - -> (...input: \`any\`[]): \`A\` - -### Parameters - - -| Parameter | Type | -| :------ | :------ | -| ...input | \`any\`[] | - - -### Returns - -\`A\` - - - -" -`; - -exports[`Declarations: should compile declaration with accessors 1`] = ` -"> \`let\` **getterAndSetter**: \`object\` - -[partial: sources] - -## Type declaration - -> **prop**: \`string\` - -[partial: sources] - - -> get **getMe()**: [\`Promise\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\> - -[partial: sources] - - -> set **setMe**(x: \`string\`): \`void\` - -[partial: sources] - - - -" -`; - -exports[`Declarations: should compile declaration with double underscores in name and value 1`] = ` -"> \`const\` **\\_\\_DOUBLE\\_UNDERSCORES\\_DECLARATION\\_\\_**: *typeof* [\`__DOUBLE_UNDERSCORES_DECLARATION__\`](variables/variable._DOUBLE_UNDERSCORES_DECLARATION__.md) - -Comments - -[partial: sources] - -" -`; - -exports[`Declarations: should compile enum declaration 1`] = ` -"> **Down**: 1 - -[partial: sources] - -" -`; - -exports[`Declarations: should compile enum declaration with defaults 1`] = ` -"> **East**: "East" - -[partial: sources] - -" -`; - -exports[`Declarations: should compile function declaration 1`] = ` -"> **functionDeclaration** - -[partial: sources] - -" -`; - -exports[`Declarations: should compile indexable declaration 1`] = ` -"> \`let\` **indexableDeclaration**: \`object\` - -[partial: sources] - -## Index signature - - \\[\`index\`: \`number\`\\]: \`string\` - -## Type declaration - -> **arg1**: \`string\` - -[partial: sources] - - - -" -`; - -exports[`Declarations: should compile object literal cast as a const 1`] = ` -"> \`const\` **objectLiteralAsConstDeclaration**: \`object\` - -[partial: sources] - -## Type declaration - -> \`readonly\` **Prop1**: "Prop1" = \`'Prop1'\` - -[partial: sources] - - -> \`readonly\` **Prop2**: "Prop2" = \`'Prop2'\` - -[partial: sources] - - -> \`readonly\` **Prop3**: "Prop3" = \`'Prop3'\` - -[partial: sources] - - - -" -`; - -exports[`Declarations: should compile object literal declaration 1`] = ` -"> \`const\` **objectLiteralDeclaration**: \`object\` - -Comments for object literal - -[partial: sources] - -## Type declaration - -> **valueA**: \`number\` = \`100\` - -Comment for valueA - -[partial: sources] - - -> **valueB**: \`boolean\` = \`true\` - -[partial: sources] - - -> **valueC**: \`object\` = \`{}\` - -[partial: sources] - - -> **valueX**: \`object\` - -Comment for valueX - -[partial: sources] - -### Type declaration (valueX) - -> > **valueA**: \`number\`[] -> -> Comment for valueA -> -> [partial: sources] -> -> -> > **valueB**: \`object\` -> -> [partial: sources] -> -> #### Type declaration (valueB) -> -> > > **valueB1**: \`number\` = \`1\` -> > -> > [partial: sources] -> > -> > -> > > **valueB2**: \`number\` = \`2\` -> > -> > [partial: sources] -> > -> > -> -> -> > **valueZ**: \`string\` = \`'foo'\` -> -> Comment for valueZ -> -> [partial: sources] -> -> - - -> **valueY**: \`Function\` - -[partial: sources] - -### Type declaration (valueY) - -> > (): \`string\` -> -> Comment for value Y -> -> [partial: sources] -> -> #### Returns -> -> \`string\` -> -> - - -> **valueZ**: \`string\` = \`'foo'\` - -Comment for valueZ - -[partial: sources] - - - -" -`; - -exports[`Declarations: should compile type literal declaration 1`] = ` -"> \`let\` **typeLiteralDeclaration**: \`object\` - -[partial: sources] - -## Type declaration - -> **valueA**?: \`number\` - -Comments for valueA - -[partial: sources] - - -> **valueB**?: \`boolean\` - -[partial: sources] - - -> **valueC**: \`object\` - -[partial: sources] - -### Index signature - - \\[\`dataId\`: \`string\`\\]: "ok" \\| "ko" - - -> **valueX**: \`object\` - -Comment for valueX - -[partial: sources] - -### Type declaration (valueX) - -> > **valueA**: \`number\`[] -> -> [partial: sources] -> -> -> > **valueY**: \`Function\` -> -> [partial: sources] -> -> #### Type declaration (valueY) -> -> > > (z: \`string\`): \`object\` -> > -> > Nested comment for valueX.valueY -> > -> > [partial: sources] -> > -> > ##### Parameters -> > -> > -> > | Parameter | Type | -> > | :------ | :------ | -> > | z | \`string\` | -> > -> > -> > ##### Returns -> > -> > \`object\` -> > -> > > **a**: \`string\` -> > -> > [partial: sources] -> > -> > -> > > **b**: \`string\` -> > -> > [partial: sources] -> > -> > -> > -> > -> -> -> > **valueZ**: \`string\` -> -> Nested comment for valueX.valueZ -> -> [partial: sources] -> -> - - -> **valueY**: \`Function\` - -[partial: sources] - -### Type declaration (valueY) - -> > (): \`string\` -> -> [partial: sources] -> -> #### Returns -> -> \`string\` -> -> - - -> **valueZ**: \`string\` - -Comment for valueZ - -[partial: sources] - - - -" -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/generics.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/generics.spec.ts.snap deleted file mode 100644 index 506a47ee..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/generics.spec.ts.snap +++ /dev/null @@ -1,87 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Generics: should compile class with type params 1`] = ` -"[partial: pageHeader] - -[partial: breadcrumbs] - -# ClassWithTypeParams\`\` - -**\`Class\`** - -[partial: comment] - -[partial: sources] - -## Type parameters - - -| Parameter | -| :------ | -| T | -| V | - - -[partial: members]" -`; - -exports[`Generics: should compile function with a simple type param' 1`] = ` -"> **functionWithTypeParam**\\(): \`boolean\` - -[partial: sources] - -## Type parameters - - -| Parameter | -| :------ | -| A | - - -## Returns - -\`boolean\` - -" -`; - -exports[`Generics: should compile function with complex type params' 1`] = ` -"> **functionWithTypeParams**\\(): \`boolean\` - -[partial: comment] - -[partial: sources] - -## Type parameters - - -| Parameter | Default | Description | -| :------ | :------ | :------ | -| A | - | [partial: comment] | -| B *extends* [\`ClassWithTypeParams\`](classes/class.ClassWithTypeParams.md)\\<\`string\`, \`number\`, \`B\`\\> | - | [partial: comment] | -| C | \`string\` \\| \`boolean\` | - | -| D | \`string\` | - | - - -## Returns - -\`boolean\` - -" -`; - -exports[`Generics: should compile generics with defaults' 1`] = ` -"> **genericsWithDefaults** - -[partial: sources] - -" -`; - -exports[`Generics: should compile type with nested generics' 1`] = ` -"> **nestedGenerics**: [\`Generic1\`](type-aliases/type-alias.Generic1.md)\\<[\`Generic2\`](type-aliases/type-alias.Generic2.md)\\<[\`Generic3\`](type-aliases/type-alias.Generic3.md)\\<\`string\`\\>\\>\\> - -[partial: sources] - -" -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap deleted file mode 100644 index 5e07ebc8..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap +++ /dev/null @@ -1,273 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Groups: (excludeGroups=false) should render group TOC' 1`] = ` -"## Index - -### Enumerations - -- [EnumA](exports.md#enuma) -- [EnumB](exports.md#enumb) - -### Classes - -- [ClassA](exports.md#classa) -- [ClassB](exports.md#classb) - -### Interfaces - -- [InterfaceA](exports.md#interfacea) -- [InterfaceB](exports.md#interfaceb) - -### Type Aliases - -- [typeA](exports.md#typea) -- [typeB](exports.md#typeb) - -### Variables - -- [variableA](exports.md#variablea) -- [variableB](exports.md#variableb) - -### Functions - -- [functionA](exports.md#functiona) -- [functionB](exports.md#functionb) -" -`; - -exports[`Groups: (excludeGroups=false) should render group members' 1`] = ` -"## Enumerations - -### EnumA - -[partial: reflectionMember] - - - ---- - -### EnumB - -[partial: reflectionMember] - - - ---- - -## Classes - -### ClassA - -[partial: reflectionMember] - - - ---- - -### ClassB - -[partial: reflectionMember] - - - ---- - -## Interfaces - -### InterfaceA - -[partial: reflectionMember] - - - ---- - -### InterfaceB - -[partial: reflectionMember] - - - ---- - -## Type Aliases - -### typeA - -[partial: declarationMember] - - - ---- - -### typeB - -[partial: declarationMember] - - - ---- - -## Variables - -### variableA - -[partial: declarationMember] - - - ---- - -### variableB - -[partial: declarationMember] - - - ---- - -## Functions - -### functionA() - -[partial: signatureMember] - - - ---- - -### functionB() - -[partial: signatureMember] - - - ----" -`; - -exports[`Groups: (excludeGroups=true) should render group TOC' 1`] = ` -"## Index - -- [EnumA](exports.md#enuma) -- [EnumB](exports.md#enumb) -- [ClassA](exports.md#classa) -- [ClassB](exports.md#classb) -- [InterfaceA](exports.md#interfacea) -- [InterfaceB](exports.md#interfaceb) -- [typeA](exports.md#typea) -- [typeB](exports.md#typeb) -- [variableA](exports.md#variablea) -- [variableB](exports.md#variableb) -- [functionA](exports.md#functiona) -- [functionB](exports.md#functionb)" -`; - -exports[`Groups: (excludeGroups=true) should render group members' 1`] = ` -"## Enumerations - -### EnumA - -[partial: reflectionMember] - - - ---- - -### EnumB - -[partial: reflectionMember] - - - ---- - -## Classes - -### ClassA - -[partial: reflectionMember] - - - ---- - -### ClassB - -[partial: reflectionMember] - - - ---- - -## Interfaces - -### InterfaceA - -[partial: reflectionMember] - - - ---- - -### InterfaceB - -[partial: reflectionMember] - - - ---- - -## Type Aliases - -### typeA - -[partial: declarationMember] - - - ---- - -### typeB - -[partial: declarationMember] - - - ---- - -## Variables - -### variableA - -[partial: declarationMember] - - - ---- - -### variableB - -[partial: declarationMember] - - - ---- - -## Functions - -### functionA() - -[partial: signatureMember] - - - ---- - -### functionB() - -[partial: signatureMember] - - - ----" -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/hierarchy.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/hierarchy.spec.ts.snap deleted file mode 100644 index 7b148c4d..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/hierarchy.spec.ts.snap +++ /dev/null @@ -1,8 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Hierarchy: should compile nested type hierarchy 1`] = `"- [\`ParentClass\`](classes/class.ParentClass.md).**\`ChildClassA\`**"`; - -exports[`Hierarchy: should compile type hierarchy 1`] = ` -"- [\`ChildClassA\`](classes/class.ChildClassA.md) -- [\`ChildClassB\`](classes/class.ChildClassB.md)" -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap deleted file mode 100644 index db466ccc..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap +++ /dev/null @@ -1,1758 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Navigation: (Monorepo) should get urls (entryPointStrategy=packages) 1`] = ` -[ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [], - "title": "numberRegexp", - "url": "child-package/namespaces/namespace.Validation/variables/variable.numberRegexp.md", - }, - ], - "title": "Variables", - }, - ], - "title": "Validation", - "url": "child-package/namespaces/namespace.Validation/index.md", - }, - ], - "title": "Namespaces", - }, - { - "children": [ - { - "children": [], - "title": "hello", - "url": "child-package/variables/variable.hello.md", - }, - ], - "title": "Variables", - }, - ], - "title": "child-package", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "hello", - "url": "child-package-2/variables/variable.hello-1.md", - }, - ], - "title": "Variables", - }, - ], - "title": "child-package-2", - }, -] -`; - -exports[`Navigation: (Monorepo) should get urls (entryPointStrategy=packages, includeFileNumberPrefixes=true) 1`] = ` -[ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [], - "title": "numberRegexp", - "url": "02-child-package/02-Namespaces/02-namespace.Validation/01-Variables/01-variable.numberRegexp.md", - }, - ], - "title": "Variables", - }, - ], - "title": "Validation", - "url": "02-child-package/02-Namespaces/02-namespace.Validation/index.md", - }, - ], - "title": "Namespaces", - }, - { - "children": [ - { - "children": [], - "title": "hello", - "url": "02-child-package/03-Variables/02-variable.hello.md", - }, - ], - "title": "Variables", - }, - ], - "title": "child-package", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "hello", - "url": "03-child-package-2/01-Variables/01-variable.hello-1.md", - }, - ], - "title": "Variables", - }, - ], - "title": "child-package-2", - }, -] -`; - -exports[`Navigation: (Multiple entrypoints) should get urls (excludeGroups=false) 1`] = ` -[ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA1", - "url": "module.categories/interfaces/CategoryA/interface.CategoryInterfaceA1.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA2", - "url": "module.categories/interfaces/CategoryA/interface.CategoryInterfaceA2.md", - }, - ], - "title": "CategoryA", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "OtherInterfaceA", - "url": "module.categories/interfaces/Other/interface.OtherInterfaceA.md", - }, - ], - "title": "Other", - }, - ], - "title": "Interfaces", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "categoryVariableA1", - "url": "module.categories/variables/CategoryA/variable.categoryVariableA1.md", - }, - { - "children": [], - "title": "categoryVariableA2", - "url": "module.categories/variables/CategoryA/variable.categoryVariableA2.md", - }, - ], - "title": "CategoryA", - }, - { - "children": [ - { - "children": [], - "title": "categoryVariableB1", - "url": "module.categories/variables/CategoryB/variable.categoryVariableB1.md", - }, - ], - "title": "CategoryB", - }, - { - "children": [ - { - "children": [], - "title": "otherVariableA", - "url": "module.categories/variables/Other/variable.otherVariableA.md", - }, - { - "children": [], - "title": "otherVariableB", - "url": "module.categories/variables/Other/variable.otherVariableB.md", - }, - ], - "title": "Other", - }, - ], - "title": "Variables", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "categoryFunctionA1", - "url": "module.categories/functions/CategoryA/function.categoryFunctionA1.md", - }, - { - "children": [], - "title": "categoryFunctionA2", - "url": "module.categories/functions/CategoryA/function.categoryFunctionA2.md", - }, - { - "children": [], - "title": "categoryFunctionA3", - "url": "module.categories/functions/CategoryA/function.categoryFunctionA3.md", - }, - ], - "title": "CategoryA", - }, - { - "children": [ - { - "children": [], - "title": "categoryFunctionB2", - "url": "module.categories/functions/CategoryB/function.categoryFunctionB2.md", - }, - ], - "title": "CategoryB", - }, - { - "children": [ - { - "children": [], - "title": "otherFunctionA", - "url": "module.categories/functions/Other/function.otherFunctionA.md", - }, - { - "children": [], - "title": "otherFunctionB", - "url": "module.categories/functions/Other/function.otherFunctionB.md", - }, - ], - "title": "Other", - }, - ], - "title": "Functions", - }, - ], - "title": "categories", - "url": "module.categories/index.md", - }, - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [], - "title": "nestedNamespaceVariable", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/namespaces/namespace.nestedNamespace/variables/variable.nestedNamespaceVariable.md", - }, - ], - "title": "Variables", - }, - ], - "title": "_nestedNamespace", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/namespaces/namespace.nestedNamespace/index.md", - }, - ], - "title": "Namespaces", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Enumeration Members", - }, - ], - "title": "NamespaceEnum", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/enumerations/enumeration.NamespaceEnum.md", - }, - ], - "title": "Enumerations", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Constructors", - }, - ], - "title": "NameSpaceClassA", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/classes/class.NameSpaceClassA.md", - }, - ], - "title": "Classes", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "NamespaceInterface", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/interfaces/interface.NamespaceInterface.md", - }, - ], - "title": "Interfaces", - }, - { - "children": [ - { - "children": [], - "title": "NamespaceTypeLiteral", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/type-aliases/type-alias.NamespaceTypeLiteral.md", - }, - ], - "title": "Type Aliases", - }, - { - "children": [ - { - "children": [], - "title": "namespaceVariableA", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/variables/variable.namespaceVariableA.md", - }, - { - "children": [], - "title": "namespaceVariableB", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/variables/variable.namespaceVariableB.md", - }, - ], - "title": "Variables", - }, - ], - "title": "someNameSpace", - "url": "module.modules_module_1/namespaces/namespace.someNameSpace/index.md", - }, - { - "children": [], - "title": "someNameSpaceB", - "url": "module.modules_module_1/namespaces/namespace.someNameSpaceB/index.md", - }, - ], - "title": "Namespaces", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Enumeration Members", - }, - ], - "title": "Module1EnumA", - "url": "module.modules_module_1/enumerations/enumeration.Module1EnumA.md", - }, - { - "children": [ - { - "children": [], - "title": "Enumeration Members", - }, - ], - "title": "Module1EnumB", - "url": "module.modules_module_1/enumerations/enumeration.Module1EnumB.md", - }, - ], - "title": "Enumerations", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Constructors", - }, - { - "children": [], - "title": "Properties", - }, - { - "children": [], - "title": "Methods", - }, - ], - "title": "Module1ClassA", - "url": "module.modules_module_1/classes/class.Module1ClassA.md", - }, - { - "children": [ - { - "children": [], - "title": "Constructors", - }, - { - "children": [], - "title": "Properties", - }, - { - "children": [], - "title": "Methods", - }, - ], - "title": "Module1ClassB", - "url": "module.modules_module_1/classes/class.Module1ClassB.md", - }, - ], - "title": "Classes", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "Module1InterfaceA", - "url": "module.modules_module_1/interfaces/interface.Module1InterfaceA.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "Module1InterfaceB", - "url": "module.modules_module_1/interfaces/interface.Module1InterfaceB.md", - }, - ], - "title": "Interfaces", - }, - { - "children": [ - { - "children": [], - "title": "Module1TypeLiteralA", - "url": "module.modules_module_1/type-aliases/type-alias.Module1TypeLiteralA.md", - }, - { - "children": [], - "title": "Module1TypeLiteralB", - "url": "module.modules_module_1/type-aliases/type-alias.Module1TypeLiteralB.md", - }, - ], - "title": "Type Aliases", - }, - { - "children": [ - { - "children": [], - "title": "module1VariableA", - "url": "module.modules_module_1/variables/variable.module1VariableA.md", - }, - { - "children": [], - "title": "module1VariableB", - "url": "module.modules_module_1/variables/variable.module1VariableB.md", - }, - ], - "title": "Variables", - }, - { - "children": [ - { - "children": [], - "title": "module1FunctionA", - "url": "module.modules_module_1/functions/function.module1FunctionA.md", - }, - { - "children": [], - "title": "module1FunctionB", - "url": "module.modules_module_1/functions/function.module1FunctionB.md", - }, - ], - "title": "Functions", - }, - ], - "title": "modules/module-1", - "url": "module.modules_module_1/index.md", - }, -] -`; - -exports[`Navigation: (Multiple entrypoints) should get urls (excludeGroups=false, includeFileNumberPrefixes: true) 1`] = ` -[ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA1", - "url": "02-module.categories/01-Interfaces/01-CategoryA/01-interface.CategoryInterfaceA1.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA2", - "url": "02-module.categories/01-Interfaces/01-CategoryA/02-interface.CategoryInterfaceA2.md", - }, - ], - "title": "CategoryA", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "OtherInterfaceA", - "url": "02-module.categories/01-Interfaces/02-Other/01-interface.OtherInterfaceA.md", - }, - ], - "title": "Other", - }, - ], - "title": "Interfaces", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "categoryVariableA1", - "url": "02-module.categories/02-Variables/01-CategoryA/01-variable.categoryVariableA1.md", - }, - { - "children": [], - "title": "categoryVariableA2", - "url": "02-module.categories/02-Variables/01-CategoryA/02-variable.categoryVariableA2.md", - }, - ], - "title": "CategoryA", - }, - { - "children": [ - { - "children": [], - "title": "categoryVariableB1", - "url": "02-module.categories/02-Variables/02-CategoryB/01-variable.categoryVariableB1.md", - }, - ], - "title": "CategoryB", - }, - { - "children": [ - { - "children": [], - "title": "otherVariableA", - "url": "02-module.categories/02-Variables/03-Other/01-variable.otherVariableA.md", - }, - { - "children": [], - "title": "otherVariableB", - "url": "02-module.categories/02-Variables/03-Other/02-variable.otherVariableB.md", - }, - ], - "title": "Other", - }, - ], - "title": "Variables", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "categoryFunctionA1", - "url": "02-module.categories/03-Functions/01-CategoryA/01-function.categoryFunctionA1.md", - }, - { - "children": [], - "title": "categoryFunctionA2", - "url": "02-module.categories/03-Functions/01-CategoryA/02-function.categoryFunctionA2.md", - }, - { - "children": [], - "title": "categoryFunctionA3", - "url": "02-module.categories/03-Functions/01-CategoryA/03-function.categoryFunctionA3.md", - }, - ], - "title": "CategoryA", - }, - { - "children": [ - { - "children": [], - "title": "categoryFunctionB2", - "url": "02-module.categories/03-Functions/02-CategoryB/01-function.categoryFunctionB2.md", - }, - ], - "title": "CategoryB", - }, - { - "children": [ - { - "children": [], - "title": "otherFunctionA", - "url": "02-module.categories/03-Functions/03-Other/01-function.otherFunctionA.md", - }, - { - "children": [], - "title": "otherFunctionB", - "url": "02-module.categories/03-Functions/03-Other/02-function.otherFunctionB.md", - }, - ], - "title": "Other", - }, - ], - "title": "Functions", - }, - ], - "title": "categories", - "url": "02-module.categories/index.md", - }, - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [], - "title": "nestedNamespaceVariable", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/01-Namespaces/01-namespace.nestedNamespace/01-Variables/01-variable.nestedNamespaceVariable.md", - }, - ], - "title": "Variables", - }, - ], - "title": "_nestedNamespace", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/01-Namespaces/01-namespace.nestedNamespace/index.md", - }, - ], - "title": "Namespaces", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Enumeration Members", - }, - ], - "title": "NamespaceEnum", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/02-Enumerations/01-enumeration.NamespaceEnum.md", - }, - ], - "title": "Enumerations", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Constructors", - }, - ], - "title": "NameSpaceClassA", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/03-Classes/01-class.NameSpaceClassA.md", - }, - ], - "title": "Classes", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "NamespaceInterface", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/04-Interfaces/01-interface.NamespaceInterface.md", - }, - ], - "title": "Interfaces", - }, - { - "children": [ - { - "children": [], - "title": "NamespaceTypeLiteral", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/05-Type Aliases/01-type-alias.NamespaceTypeLiteral.md", - }, - ], - "title": "Type Aliases", - }, - { - "children": [ - { - "children": [], - "title": "namespaceVariableA", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/06-Variables/01-variable.namespaceVariableA.md", - }, - { - "children": [], - "title": "namespaceVariableB", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/06-Variables/02-variable.namespaceVariableB.md", - }, - ], - "title": "Variables", - }, - ], - "title": "someNameSpace", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/index.md", - }, - { - "children": [], - "title": "someNameSpaceB", - "url": "03-module.modules_module_1/01-Namespaces/02-namespace.someNameSpaceB/index.md", - }, - ], - "title": "Namespaces", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Enumeration Members", - }, - ], - "title": "Module1EnumA", - "url": "03-module.modules_module_1/02-Enumerations/01-enumeration.Module1EnumA.md", - }, - { - "children": [ - { - "children": [], - "title": "Enumeration Members", - }, - ], - "title": "Module1EnumB", - "url": "03-module.modules_module_1/02-Enumerations/02-enumeration.Module1EnumB.md", - }, - ], - "title": "Enumerations", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Constructors", - }, - { - "children": [], - "title": "Properties", - }, - { - "children": [], - "title": "Methods", - }, - ], - "title": "Module1ClassA", - "url": "03-module.modules_module_1/03-Classes/01-class.Module1ClassA.md", - }, - { - "children": [ - { - "children": [], - "title": "Constructors", - }, - { - "children": [], - "title": "Properties", - }, - { - "children": [], - "title": "Methods", - }, - ], - "title": "Module1ClassB", - "url": "03-module.modules_module_1/03-Classes/02-class.Module1ClassB.md", - }, - ], - "title": "Classes", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "Module1InterfaceA", - "url": "03-module.modules_module_1/04-Interfaces/01-interface.Module1InterfaceA.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "Module1InterfaceB", - "url": "03-module.modules_module_1/04-Interfaces/02-interface.Module1InterfaceB.md", - }, - ], - "title": "Interfaces", - }, - { - "children": [ - { - "children": [], - "title": "Module1TypeLiteralA", - "url": "03-module.modules_module_1/05-Type Aliases/01-type-alias.Module1TypeLiteralA.md", - }, - { - "children": [], - "title": "Module1TypeLiteralB", - "url": "03-module.modules_module_1/05-Type Aliases/02-type-alias.Module1TypeLiteralB.md", - }, - ], - "title": "Type Aliases", - }, - { - "children": [ - { - "children": [], - "title": "module1VariableA", - "url": "03-module.modules_module_1/06-Variables/01-variable.module1VariableA.md", - }, - { - "children": [], - "title": "module1VariableB", - "url": "03-module.modules_module_1/06-Variables/02-variable.module1VariableB.md", - }, - ], - "title": "Variables", - }, - { - "children": [ - { - "children": [], - "title": "module1FunctionA", - "url": "03-module.modules_module_1/07-Functions/01-function.module1FunctionA.md", - }, - { - "children": [], - "title": "module1FunctionB", - "url": "03-module.modules_module_1/07-Functions/02-function.module1FunctionB.md", - }, - ], - "title": "Functions", - }, - ], - "title": "modules/module-1", - "url": "03-module.modules_module_1/index.md", - }, -] -`; - -exports[`Navigation: (Multiple entrypoints) should get urls (excludeGroups=false, outputFileStrategy=modules, includeFileNumberPrefixes: true) 1`] = ` -[ - { - "children": [ - { - "children": [ - { - "children": [], - "title": "CategoryA", - }, - { - "children": [], - "title": "Other", - }, - ], - "title": "Interfaces", - }, - { - "children": [ - { - "children": [], - "title": "CategoryA", - }, - { - "children": [], - "title": "CategoryB", - }, - { - "children": [], - "title": "Other", - }, - ], - "title": "Variables", - }, - { - "children": [ - { - "children": [], - "title": "CategoryA", - }, - { - "children": [], - "title": "CategoryB", - }, - { - "children": [], - "title": "Other", - }, - ], - "title": "Functions", - }, - ], - "title": "categories", - "url": "02-module.categories.md", - }, - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": [], - "title": "Variables", - }, - ], - "title": "_nestedNamespace", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/01-Namespaces/01-namespace.nestedNamespace.md", - }, - ], - "title": "Namespaces", - }, - { - "children": [], - "title": "Enumerations", - }, - { - "children": [], - "title": "Classes", - }, - { - "children": [], - "title": "Interfaces", - }, - { - "children": [], - "title": "Type Aliases", - }, - { - "children": [], - "title": "Variables", - }, - ], - "title": "someNameSpace", - "url": "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/index.md", - }, - { - "children": [], - "title": "someNameSpaceB", - "url": "03-module.modules_module_1/01-Namespaces/02-namespace.someNameSpaceB.md", - }, - ], - "title": "Namespaces", - }, - { - "children": [], - "title": "Enumerations", - }, - { - "children": [], - "title": "Classes", - }, - { - "children": [], - "title": "Interfaces", - }, - { - "children": [], - "title": "Type Aliases", - }, - { - "children": [], - "title": "Variables", - }, - { - "children": [], - "title": "Functions", - }, - ], - "title": "modules/module-1", - "url": "03-module.modules_module_1/index.md", - }, -] -`; - -exports[`Navigation: (Multiple entrypoints) should get urls (excludeGroups=true, includeFileNumberPrefixes: true) 1`] = ` -[ - { - "children": [ - { - "children": [], - "title": "CategoryInterfaceA1", - "url": "02-module.categories/01-CategoryA/01-interface.CategoryInterfaceA1.md", - }, - { - "children": [], - "title": "CategoryInterfaceA2", - "url": "02-module.categories/01-CategoryA/02-interface.CategoryInterfaceA2.md", - }, - { - "children": [], - "title": "OtherInterfaceA", - "url": "02-module.categories/03-Other/01-interface.OtherInterfaceA.md", - }, - { - "children": undefined, - "title": "categoryVariableA1", - "url": "02-module.categories/01-CategoryA/03-variable.categoryVariableA1.md", - }, - { - "children": undefined, - "title": "categoryVariableA2", - "url": "02-module.categories/01-CategoryA/04-variable.categoryVariableA2.md", - }, - { - "children": undefined, - "title": "categoryVariableB1", - "url": "02-module.categories/02-CategoryB/01-variable.categoryVariableB1.md", - }, - { - "children": undefined, - "title": "otherVariableA", - "url": "02-module.categories/03-Other/02-variable.otherVariableA.md", - }, - { - "children": undefined, - "title": "otherVariableB", - "url": "02-module.categories/03-Other/03-variable.otherVariableB.md", - }, - { - "children": undefined, - "title": "categoryFunctionA1", - "url": "02-module.categories/01-CategoryA/05-function.categoryFunctionA1.md", - }, - { - "children": undefined, - "title": "categoryFunctionA2", - "url": "02-module.categories/01-CategoryA/06-function.categoryFunctionA2.md", - }, - { - "children": undefined, - "title": "categoryFunctionA3", - "url": "02-module.categories/01-CategoryA/07-function.categoryFunctionA3.md", - }, - { - "children": undefined, - "title": "categoryFunctionB2", - "url": "02-module.categories/02-CategoryB/02-function.categoryFunctionB2.md", - }, - { - "children": undefined, - "title": "otherFunctionA", - "url": "02-module.categories/03-Other/04-function.otherFunctionA.md", - }, - { - "children": undefined, - "title": "otherFunctionB", - "url": "02-module.categories/03-Other/05-function.otherFunctionB.md", - }, - ], - "title": "categories", - "url": "02-module.categories/index.md", - }, - { - "children": [ - { - "children": [ - { - "children": [ - { - "children": undefined, - "title": "nestedNamespaceVariable", - "url": "03-module.modules_module_1/01-someNameSpace/01-nestedNamespace/01-variable.nestedNamespaceVariable.md", - }, - ], - "title": "_nestedNamespace", - "url": "03-module.modules_module_1/01-someNameSpace/01-nestedNamespace/index.md", - }, - { - "children": [], - "title": "NamespaceEnum", - "url": "03-module.modules_module_1/01-someNameSpace/02-enumeration.NamespaceEnum.md", - }, - { - "children": [], - "title": "NameSpaceClassA", - "url": "03-module.modules_module_1/01-someNameSpace/03-class.NameSpaceClassA.md", - }, - { - "children": [], - "title": "NamespaceInterface", - "url": "03-module.modules_module_1/01-someNameSpace/04-interface.NamespaceInterface.md", - }, - { - "children": undefined, - "title": "NamespaceTypeLiteral", - "url": "03-module.modules_module_1/01-someNameSpace/05-type-alias.NamespaceTypeLiteral.md", - }, - { - "children": undefined, - "title": "namespaceVariableA", - "url": "03-module.modules_module_1/01-someNameSpace/06-variable.namespaceVariableA.md", - }, - { - "children": undefined, - "title": "namespaceVariableB", - "url": "03-module.modules_module_1/01-someNameSpace/07-variable.namespaceVariableB.md", - }, - ], - "title": "someNameSpace", - "url": "03-module.modules_module_1/01-someNameSpace/index.md", - }, - { - "children": undefined, - "title": "someNameSpaceB", - "url": "03-module.modules_module_1/02-someNameSpaceB/index.md", - }, - { - "children": [], - "title": "Module1EnumA", - "url": "03-module.modules_module_1/03-enumeration.Module1EnumA.md", - }, - { - "children": [], - "title": "Module1EnumB", - "url": "03-module.modules_module_1/04-enumeration.Module1EnumB.md", - }, - { - "children": [], - "title": "Module1ClassA", - "url": "03-module.modules_module_1/05-class.Module1ClassA.md", - }, - { - "children": [], - "title": "Module1ClassB", - "url": "03-module.modules_module_1/06-class.Module1ClassB.md", - }, - { - "children": [], - "title": "Module1InterfaceA", - "url": "03-module.modules_module_1/07-interface.Module1InterfaceA.md", - }, - { - "children": [], - "title": "Module1InterfaceB", - "url": "03-module.modules_module_1/08-interface.Module1InterfaceB.md", - }, - { - "children": undefined, - "title": "Module1TypeLiteralA", - "url": "03-module.modules_module_1/09-type-alias.Module1TypeLiteralA.md", - }, - { - "children": undefined, - "title": "Module1TypeLiteralB", - "url": "03-module.modules_module_1/10-type-alias.Module1TypeLiteralB.md", - }, - { - "children": undefined, - "title": "module1VariableA", - "url": "03-module.modules_module_1/11-variable.module1VariableA.md", - }, - { - "children": undefined, - "title": "module1VariableB", - "url": "03-module.modules_module_1/12-variable.module1VariableB.md", - }, - { - "children": undefined, - "title": "module1FunctionA", - "url": "03-module.modules_module_1/13-function.module1FunctionA.md", - }, - { - "children": undefined, - "title": "module1FunctionB", - "url": "03-module.modules_module_1/14-function.module1FunctionB.md", - }, - ], - "title": "modules/module-1", - "url": "03-module.modules_module_1/index.md", - }, -] -`; - -exports[`Navigation: (Multiple entrypoints) should get urls (excludeGroups=true, outputFileStrategy=modules, includeFileNumberPrefixes: true, readme=none) 1`] = ` -[ - { - "children": [], - "title": "categories", - "url": "01-module.categories.md", - }, - { - "children": [ - { - "children": [ - { - "children": [], - "title": "_nestedNamespace", - "url": "02-module.modules_module_1/01-someNameSpace/01-nestedNamespace.md", - }, - ], - "title": "someNameSpace", - "url": "02-module.modules_module_1/01-someNameSpace/index.md", - }, - { - "children": undefined, - "title": "someNameSpaceB", - "url": "02-module.modules_module_1/02-someNameSpaceB.md", - }, - ], - "title": "modules/module-1", - "url": "02-module.modules_module_1/index.md", - }, -] -`; - -exports[`Navigation: (Single entrypoint) should get urls (excludeGroups=false, includeFileNumberPrefixes=true) 1`] = ` -[ - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA1", - "url": "02-Interfaces/02-interface.CategoryInterfaceA1.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA2", - "url": "02-Interfaces/03-interface.CategoryInterfaceA2.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "OtherInterfaceA", - "url": "02-Interfaces/04-interface.OtherInterfaceA.md", - }, - { - "children": [], - "title": "categoryVariableA1", - "url": "03-Variables/02-variable.categoryVariableA1.md", - }, - { - "children": [], - "title": "categoryVariableA2", - "url": "03-Variables/03-variable.categoryVariableA2.md", - }, - { - "children": [], - "title": "categoryVariableB1", - "url": "03-Variables/04-variable.categoryVariableB1.md", - }, - { - "children": [], - "title": "otherVariableA", - "url": "03-Variables/05-variable.otherVariableA.md", - }, - { - "children": [], - "title": "otherVariableB", - "url": "03-Variables/06-variable.otherVariableB.md", - }, - { - "children": [], - "title": "categoryFunctionA1", - "url": "04-Functions/02-function.categoryFunctionA1.md", - }, - { - "children": [], - "title": "categoryFunctionA2", - "url": "04-Functions/03-function.categoryFunctionA2.md", - }, - { - "children": [], - "title": "categoryFunctionA3", - "url": "04-Functions/04-function.categoryFunctionA3.md", - }, - { - "children": [], - "title": "categoryFunctionB2", - "url": "04-Functions/05-function.categoryFunctionB2.md", - }, - { - "children": [], - "title": "otherFunctionA", - "url": "04-Functions/06-function.otherFunctionA.md", - }, - { - "children": [], - "title": "otherFunctionB", - "url": "04-Functions/07-function.otherFunctionB.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA1", - "url": "02-Interfaces/02-interface.CategoryInterfaceA1.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA2", - "url": "02-Interfaces/03-interface.CategoryInterfaceA2.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "OtherInterfaceA", - "url": "02-Interfaces/04-interface.OtherInterfaceA.md", - }, - { - "children": [], - "title": "categoryVariableA1", - "url": "03-Variables/02-variable.categoryVariableA1.md", - }, - { - "children": [], - "title": "categoryVariableA2", - "url": "03-Variables/03-variable.categoryVariableA2.md", - }, - { - "children": [], - "title": "categoryVariableB1", - "url": "03-Variables/04-variable.categoryVariableB1.md", - }, - { - "children": [], - "title": "otherVariableA", - "url": "03-Variables/05-variable.otherVariableA.md", - }, - { - "children": [], - "title": "otherVariableB", - "url": "03-Variables/06-variable.otherVariableB.md", - }, - { - "children": [], - "title": "categoryFunctionA1", - "url": "04-Functions/02-function.categoryFunctionA1.md", - }, - { - "children": [], - "title": "categoryFunctionA2", - "url": "04-Functions/03-function.categoryFunctionA2.md", - }, - { - "children": [], - "title": "categoryFunctionA3", - "url": "04-Functions/04-function.categoryFunctionA3.md", - }, - { - "children": [], - "title": "categoryFunctionB2", - "url": "04-Functions/05-function.categoryFunctionB2.md", - }, - { - "children": [], - "title": "otherFunctionA", - "url": "04-Functions/06-function.otherFunctionA.md", - }, - { - "children": [], - "title": "otherFunctionB", - "url": "04-Functions/07-function.otherFunctionB.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA1", - "url": "02-Interfaces/02-interface.CategoryInterfaceA1.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "CategoryInterfaceA2", - "url": "02-Interfaces/03-interface.CategoryInterfaceA2.md", - }, - { - "children": [ - { - "children": [], - "title": "Properties", - }, - ], - "title": "OtherInterfaceA", - "url": "02-Interfaces/04-interface.OtherInterfaceA.md", - }, - { - "children": [], - "title": "categoryVariableA1", - "url": "03-Variables/02-variable.categoryVariableA1.md", - }, - { - "children": [], - "title": "categoryVariableA2", - "url": "03-Variables/03-variable.categoryVariableA2.md", - }, - { - "children": [], - "title": "categoryVariableB1", - "url": "03-Variables/04-variable.categoryVariableB1.md", - }, - { - "children": [], - "title": "otherVariableA", - "url": "03-Variables/05-variable.otherVariableA.md", - }, - { - "children": [], - "title": "otherVariableB", - "url": "03-Variables/06-variable.otherVariableB.md", - }, - { - "children": [], - "title": "categoryFunctionA1", - "url": "04-Functions/02-function.categoryFunctionA1.md", - }, - { - "children": [], - "title": "categoryFunctionA2", - "url": "04-Functions/03-function.categoryFunctionA2.md", - }, - { - "children": [], - "title": "categoryFunctionA3", - "url": "04-Functions/04-function.categoryFunctionA3.md", - }, - { - "children": [], - "title": "categoryFunctionB2", - "url": "04-Functions/05-function.categoryFunctionB2.md", - }, - { - "children": [], - "title": "otherFunctionA", - "url": "04-Functions/06-function.otherFunctionA.md", - }, - { - "children": [], - "title": "otherFunctionB", - "url": "04-Functions/07-function.otherFunctionB.md", - }, -] -`; - -exports[`Navigation: (Single entrypoint) should get urls (excludeGroups=true, includeFileNumberPrefixes=true, readme=none) 1`] = ` -[ - { - "children": [], - "title": "CategoryInterfaceA1", - "url": "01-interface.CategoryInterfaceA1.md", - }, - { - "children": [], - "title": "CategoryInterfaceA2", - "url": "02-interface.CategoryInterfaceA2.md", - }, - { - "children": [], - "title": "OtherInterfaceA", - "url": "03-interface.OtherInterfaceA.md", - }, - { - "children": [], - "title": "categoryVariableA1", - "url": "04-variable.categoryVariableA1.md", - }, - { - "children": [], - "title": "categoryVariableA2", - "url": "05-variable.categoryVariableA2.md", - }, - { - "children": [], - "title": "categoryVariableB1", - "url": "06-variable.categoryVariableB1.md", - }, - { - "children": [], - "title": "otherVariableA", - "url": "07-variable.otherVariableA.md", - }, - { - "children": [], - "title": "otherVariableB", - "url": "08-variable.otherVariableB.md", - }, - { - "children": [], - "title": "categoryFunctionA1", - "url": "09-function.categoryFunctionA1.md", - }, - { - "children": [], - "title": "categoryFunctionA2", - "url": "10-function.categoryFunctionA2.md", - }, - { - "children": [], - "title": "categoryFunctionA3", - "url": "11-function.categoryFunctionA3.md", - }, - { - "children": [], - "title": "categoryFunctionB2", - "url": "12-function.categoryFunctionB2.md", - }, - { - "children": [], - "title": "otherFunctionA", - "url": "13-function.otherFunctionA.md", - }, - { - "children": [], - "title": "otherFunctionB", - "url": "14-function.otherFunctionB.md", - }, - { - "children": [], - "title": "CategoryInterfaceA1", - "url": "01-interface.CategoryInterfaceA1.md", - }, - { - "children": [], - "title": "CategoryInterfaceA2", - "url": "02-interface.CategoryInterfaceA2.md", - }, - { - "children": [], - "title": "OtherInterfaceA", - "url": "03-interface.OtherInterfaceA.md", - }, - { - "children": [], - "title": "categoryVariableA1", - "url": "04-variable.categoryVariableA1.md", - }, - { - "children": [], - "title": "categoryVariableA2", - "url": "05-variable.categoryVariableA2.md", - }, - { - "children": [], - "title": "categoryVariableB1", - "url": "06-variable.categoryVariableB1.md", - }, - { - "children": [], - "title": "otherVariableA", - "url": "07-variable.otherVariableA.md", - }, - { - "children": [], - "title": "otherVariableB", - "url": "08-variable.otherVariableB.md", - }, - { - "children": [], - "title": "categoryFunctionA1", - "url": "09-function.categoryFunctionA1.md", - }, - { - "children": [], - "title": "categoryFunctionA2", - "url": "10-function.categoryFunctionA2.md", - }, - { - "children": [], - "title": "categoryFunctionA3", - "url": "11-function.categoryFunctionA3.md", - }, - { - "children": [], - "title": "categoryFunctionB2", - "url": "12-function.categoryFunctionB2.md", - }, - { - "children": [], - "title": "otherFunctionA", - "url": "13-function.otherFunctionA.md", - }, - { - "children": [], - "title": "otherFunctionB", - "url": "14-function.otherFunctionB.md", - }, - { - "children": [], - "title": "CategoryInterfaceA1", - "url": "01-interface.CategoryInterfaceA1.md", - }, - { - "children": [], - "title": "CategoryInterfaceA2", - "url": "02-interface.CategoryInterfaceA2.md", - }, - { - "children": [], - "title": "OtherInterfaceA", - "url": "03-interface.OtherInterfaceA.md", - }, - { - "children": [], - "title": "categoryVariableA1", - "url": "04-variable.categoryVariableA1.md", - }, - { - "children": [], - "title": "categoryVariableA2", - "url": "05-variable.categoryVariableA2.md", - }, - { - "children": [], - "title": "categoryVariableB1", - "url": "06-variable.categoryVariableB1.md", - }, - { - "children": [], - "title": "otherVariableA", - "url": "07-variable.otherVariableA.md", - }, - { - "children": [], - "title": "otherVariableB", - "url": "08-variable.otherVariableB.md", - }, - { - "children": [], - "title": "categoryFunctionA1", - "url": "09-function.categoryFunctionA1.md", - }, - { - "children": [], - "title": "categoryFunctionA2", - "url": "10-function.categoryFunctionA2.md", - }, - { - "children": [], - "title": "categoryFunctionA3", - "url": "11-function.categoryFunctionA3.md", - }, - { - "children": [], - "title": "categoryFunctionB2", - "url": "12-function.categoryFunctionB2.md", - }, - { - "children": [], - "title": "otherFunctionA", - "url": "13-function.otherFunctionA.md", - }, - { - "children": [], - "title": "otherFunctionB", - "url": "14-function.otherFunctionB.md", - }, -] -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/signatures.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/signatures.spec.ts.snap deleted file mode 100644 index 364fef6c..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/signatures.spec.ts.snap +++ /dev/null @@ -1,403 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Signatures: should compile a promise that returns a symbol' 1`] = ` -"> **promiseReturningASymbol**(): [\`Promise\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`any\`\\> - -[partial: sources] - -## Returns - -[\`Promise\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`any\`\\> - -" -`; - -exports[`Signatures: should compile a promise that returns an object' 1`] = ` -"> **promiseReturningAnObject**(): [\`Promise\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\\{data: \`string\`; id: \`string\`;}\\> - -[partial: sources] - -## Returns - -[\`Promise\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\\{data: \`string\`; id: \`string\`;}\\> - -" -`; - -exports[`Signatures: should compile callable signature' 1`] = ` -"> **CallableSignature**(): \`string\` - -[partial: sources] - -## Returns - -\`string\` - -" -`; - -exports[`Signatures: should compile class with constructor' 1`] = ` -"> **new ClassWithConstructor**(x: \`string\`, y: \`string\`): [\`ClassWithConstructor\`](classes/class.ClassWithConstructor.md) - -[partial: sources] - -## Parameters - - -| Parameter | Type | -| :------ | :------ | -| x | \`string\` | -| y | \`string\` | - - -## Returns - -[\`ClassWithConstructor\`](classes/class.ClassWithConstructor.md) - -" -`; - -exports[`Signatures: should compile function that returns a function' 1`] = ` -"> **functionReturningAFunction**(): \`Function\` - -Comments for function - - - -[partial: sources] - -## Returns - -\`Function\` - -Return comments - -> > \\(x: \`string\`): \`boolean\` -> -> [partial: sources] -> -> ### Type parameters -> -> -> | Parameter | -> | :------ | -> | T | -> -> -> ### Parameters -> -> -> | Parameter | Type | -> | :------ | :------ | -> | x | \`string\` | -> -> -> ### Returns -> -> \`boolean\` -> -> - -" -`; - -exports[`Signatures: should compile function that returns an object' 1`] = ` -"> **functionReturningAnObject**(): \`object\` - -Comments for function - - - -[partial: sources] - -## Returns - -\`object\` - -Return comments - -> **x**: \`number\` = \`1\` - -[partial: sources] - - -> **y**: \`number\` = \`2\` - -[partial: sources] - - - -" -`; - -exports[`Signatures: should compile function with nested typen params' 1`] = ` -"> **functionWithNestedParams**(params: \`object\`, context: \`any\`): \`boolean\` - -Some nested params. - -[partial: sources] - -## Parameters - - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| params | \`object\` | The parameters passed to the method. | -| context | \`any\` | The context of the method call. | - - -## Returns - -\`boolean\` - -" -`; - -exports[`Signatures: should compile function with reference type' 1`] = ` -"> **functionWithReferenceType**(descriptor: \`TypedPropertyDescriptor\`\\<\`any\`\\>): \`boolean\` - -[partial: sources] - -## Parameters - - -| Parameter | Type | -| :------ | :------ | -| descriptor | \`TypedPropertyDescriptor\`\\<\`any\`\\> | - - -## Returns - -\`boolean\` - -" -`; - -exports[`Signatures: should compile named parameters with comments' 1`] = ` -"> **functionWithNamedParamsAndComments**(\\_\\_namedParameters: \`object\` = \`{}\`, anotherParam: \`string\`): \`void\` - -FOO - -[partial: sources] - -## Parameters - - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| \\_\\_namedParameters | \`object\` | various options | -| anotherParam | \`string\` | Another param comment | - - -## Returns - -\`void\` - -" -`; - -exports[`Signatures: should compile named parameters' 1`] = ` -"> **functionWithNamedParams**(\\_\\_namedParameters: \`Object\`): \`string\` - -[partial: sources] - -## Parameters - - -| Parameter | Type | -| :------ | :------ | -| \\_\\_namedParameters | \`Object\` | - - -## Returns - -\`string\` - -" -`; - -exports[`Signatures: should compile pipes in params and comments' 1`] = ` -"> **functionWithPipesInParamsAndComments**(n: \`number\`): \`number\` \\| \`null\` - - - -[partial: sources] - -## Parameters - - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| n | \`number\` | a\\|b | - - -## Returns - -\`number\` \\| \`null\` - -" -`; - -exports[`Signatures: should compile signature with @return comments' 1`] = ` -"> **commentsInReturn**(): \`boolean\` - -Comments with a return definition - - - -[partial: sources] - -## Returns - -\`boolean\` - -Return comments - -" -`; - -exports[`Signatures: should compile signature with a flag' 1`] = ` -"> \`Private\` **privateFunction**(): \`string\` - - - -[partial: sources] - -## Returns - -\`string\` - -" -`; - -exports[`Signatures: should compile signature with default values' 1`] = ` -"> **functionWithDefaults**( - valueA: \`string\` = \`'defaultValue'\`, - valueB: \`number\` = \`100\`, - valueC: \`number\` = \`Number.NaN\`, - valueD: \`boolean\` = \`true\`, - valueE: \`boolean\` = \`null\`, - valueF: \`string\` = \`''\`): \`string\` - -This is a function with a parameter that has a default value. - -[partial: sources] - -## Parameters - - -| Parameter | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| valueA | \`string\` | 'defaultValue' | A parameter with a default string value. | -| valueB | \`number\` | 100 | A parameter with a default numeric value. | -| valueC | \`number\` | Number.NaN | A parameter with a default NaN value. | -| valueD | \`boolean\` | true | A parameter with a default boolean value. | -| valueE | \`boolean\` | null | A parameter with a default null value. | -| valueF | \`string\` | '\\' | - | - - -## Returns - -\`string\` - -" -`; - -exports[`Signatures: should compile signature with optional params' 1`] = ` -"> **functionWithOptionalParam**( - firstParamWithDefault: \`boolean\` = \`true\`, - requiredParam: \`string\`, - optionalParam?: \`string\`, - paramWithDefault?: \`number\` = \`0\`): \`void\` - -This is a function with a parameter that is optional. - -[partial: sources] - -## Parameters - - -| Parameter | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| firstParamWithDefault | \`boolean\` | true | - | -| requiredParam | \`string\` | undefined | A normal parameter. | -| optionalParam? | \`string\` | undefined | An optional parameter. | -| paramWithDefault? | \`number\` | 0 | - | - - -## Returns - -\`void\` - -" -`; - -exports[`Signatures: should compile signature with params' 1`] = ` -"> **functionWithParameters**( - paramZ: \`string\`, - paramG: \\{prop: \`string\`;} & \\{prop: \`number\`;}, - paramA: [\`PropInterface\`](interfaces/interface.PropInterface.md)): \`number\` - -This is a function with multiple arguments and a return value. - -[partial: sources] - -## Parameters - - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| paramZ | \`string\` | This is a string parameter. | -| paramG | \\{prop: \`string\`;} & \\{prop: \`number\`;} | This is a parameter with intersection type literal. | -| paramA | [\`PropInterface\`](interfaces/interface.PropInterface.md) | This is a **parameter** pointing to an interface. | - - -## Returns - -\`number\` - -" -`; - -exports[`Signatures: should compile signature with rest params' 1`] = ` -"> **functionWithRest**(...rest: \`string\`[]): \`string\` - -This is a function with rest parameter. - -[partial: sources] - -## Parameters - - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| ...rest | \`string\`[] | The rest parameter. | - - -## Returns - -\`string\` - -" -`; - -exports[`Signatures: should compile signature with union types' 1`] = ` -"> **functionWithUnionTypes**(arg: \`number\` \\| \`boolean\`[], ...args: (\`string\` \\| \`number\`)[]): \`any\` - -[partial: sources] - -## Parameters - - -| Parameter | Type | -| :------ | :------ | -| arg | \`number\` \\| \`boolean\`[] | -| ...args | (\`string\` \\| \`number\`)[] | - - -## Returns - -\`any\` - -" -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/types.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/types.spec.ts.snap deleted file mode 100644 index 7ec46253..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/types.spec.ts.snap +++ /dev/null @@ -1,37 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Types: should compile 'array' type' 1`] = `"\`string\`[]"`; - -exports[`Types: should compile 'intersection' type' 1`] = `"[\`IntersectionClassA\`](classes/class.IntersectionClassA.md) & [\`IntersectionClassB\`](classes/class.IntersectionClassB.md)"`; - -exports[`Types: should compile 'stringLiteral' type' 1`] = `""blue""`; - -exports[`Types: should compile 'tuple' type' 1`] = `"[\`string\`, \`number\`]"`; - -exports[`Types: should compile 'typeOperator' type ' 1`] = `"*unique* \`symbol\`"`; - -exports[`Types: should compile 'union' of literal declarations 1`] = `"\\{bar: " " \\| "string" \\| "strong\\|with\\|pipes" \\| "type\\\`with\\\`backticks" \\| "\\" \\| "*";}"`; - -exports[`Types: should compile 'union' of string literals types' 1`] = `""ease-in" \\| "ease-out""`; - -exports[`Types: should compile collapsed 'function' type ' 1`] = `""`; - -exports[`Types: should compile collapsed 'literal' type' 1`] = `"\`object\`"`; - -exports[`Types: should compile collapsed 'objectLiteralType' type' 1`] = `"\`object\`"`; - -exports[`Types: should compile conditional type ' 1`] = `"\`T\` *extends* \`string\` ? "string" : \`T\` *extends* \`number\` ? "number" : \`T\` *extends* \`boolean\` ? "boolean" : \`T\` *extends* \`undefined\` ? "undefined" : "object""`; - -exports[`Types: should compile expanded 'function' type ' 1`] = `""`; - -exports[`Types: should compile expanded 'literal' type' 1`] = `"\\{valueA: \`number\`; valueB: \`boolean\`; valueX: \\{valueA: \`number\`[]; valueY: (z: \`string\`) => \\{a: \`string\`; b: \`string\`;}; valueZ: \`string\`;}; valueY: () => \`string\`; valueZ: \`string\`;}"`; - -exports[`Types: should compile expanded 'objectLiteralType' type' 1`] = `"\\{}"`; - -exports[`Types: should compile intrinsic type' 1`] = `"\`string\`"`; - -exports[`Types: should compile unionType with object literal type ' 1`] = `"\`string\` \\| \\{z: \`string\`;}"`; - -exports[`Types: should resolve external refs with type params' 1`] = `"\`ClassWithTypeParams\`\\<[\`HTMLElement\`]( https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement ), [\`Error\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error )\\>"`; - -exports[`Types: should resolve external refs' 1`] = `"[\`HTMLElement\`]( https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement )"`; diff --git a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap b/tools/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap deleted file mode 100644 index 7d620e7b..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap +++ /dev/null @@ -1,282 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Urls: (Monorepo) should get urls (entryPointStrategy=packages) 1`] = ` -[ - "README.md", - "exports.md", - "child-package/README.md", - "child-package/index.md", - "child-package/namespaces/namespace.Validation/index.md", - "child-package/namespaces/namespace.Validation/variables/variable.numberRegexp.md", - "child-package/variables/variable.hello.md", - "child-package-2/index.md", - "child-package-2/variables/variable.hello-1.md", -] -`; - -exports[`Urls: (Monorepo) should get urls (entryPointStrategy=packages, includeFileNumberPrefixes=true) 1`] = ` -[ - "README.md", - "01-exports.md", - "02-child-package/README.md", - "02-child-package/01-index.md", - "02-child-package/02-Namespaces/02-namespace.Validation/index.md", - "02-child-package/02-Namespaces/02-namespace.Validation/01-Variables/01-variable.numberRegexp.md", - "02-child-package/03-Variables/02-variable.hello.md", - "03-child-package-2/index.md", - "03-child-package-2/01-Variables/01-variable.hello-1.md", -] -`; - -exports[`Urls: (Multiple entrypoints) should get urls (excludeGroups=false) 1`] = ` -[ - "README.md", - "modules.md", - "module.categories/index.md", - "module.categories/interfaces/CategoryA/interface.CategoryInterfaceA1.md", - "module.categories/interfaces/CategoryA/interface.CategoryInterfaceA2.md", - "module.categories/interfaces/Other/interface.OtherInterfaceA.md", - "module.categories/variables/CategoryA/variable.categoryVariableA1.md", - "module.categories/variables/CategoryA/variable.categoryVariableA2.md", - "module.categories/variables/CategoryB/variable.categoryVariableB1.md", - "module.categories/variables/Other/variable.otherVariableA.md", - "module.categories/variables/Other/variable.otherVariableB.md", - "module.categories/functions/CategoryA/function.categoryFunctionA1.md", - "module.categories/functions/CategoryA/function.categoryFunctionA2.md", - "module.categories/functions/CategoryA/function.categoryFunctionA3.md", - "module.categories/functions/CategoryB/function.categoryFunctionB2.md", - "module.categories/functions/Other/function.otherFunctionA.md", - "module.categories/functions/Other/function.otherFunctionB.md", - "module.modules_module_1/index.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/index.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/namespaces/namespace.nestedNamespace/index.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/namespaces/namespace.nestedNamespace/variables/variable.nestedNamespaceVariable.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/enumerations/enumeration.NamespaceEnum.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/classes/class.NameSpaceClassA.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/interfaces/interface.NamespaceInterface.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/type-aliases/type-alias.NamespaceTypeLiteral.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/variables/variable.namespaceVariableA.md", - "module.modules_module_1/namespaces/namespace.someNameSpace/variables/variable.namespaceVariableB.md", - "module.modules_module_1/namespaces/namespace.someNameSpaceB/index.md", - "module.modules_module_1/enumerations/enumeration.Module1EnumA.md", - "module.modules_module_1/enumerations/enumeration.Module1EnumB.md", - "module.modules_module_1/classes/class.Module1ClassA.md", - "module.modules_module_1/classes/class.Module1ClassB.md", - "module.modules_module_1/interfaces/interface.Module1InterfaceA.md", - "module.modules_module_1/interfaces/interface.Module1InterfaceB.md", - "module.modules_module_1/type-aliases/type-alias.Module1TypeLiteralA.md", - "module.modules_module_1/type-aliases/type-alias.Module1TypeLiteralB.md", - "module.modules_module_1/variables/variable.module1VariableA.md", - "module.modules_module_1/variables/variable.module1VariableB.md", - "module.modules_module_1/functions/function.module1FunctionA.md", - "module.modules_module_1/functions/function.module1FunctionB.md", -] -`; - -exports[`Urls: (Multiple entrypoints) should get urls (excludeGroups=false, includeFileNumberPrefixes: true) 1`] = ` -[ - "README.md", - "01-modules.md", - "02-module.categories/index.md", - "02-module.categories/01-Interfaces/01-CategoryA/01-interface.CategoryInterfaceA1.md", - "02-module.categories/01-Interfaces/01-CategoryA/02-interface.CategoryInterfaceA2.md", - "02-module.categories/01-Interfaces/02-Other/01-interface.OtherInterfaceA.md", - "02-module.categories/02-Variables/01-CategoryA/01-variable.categoryVariableA1.md", - "02-module.categories/02-Variables/01-CategoryA/02-variable.categoryVariableA2.md", - "02-module.categories/02-Variables/02-CategoryB/01-variable.categoryVariableB1.md", - "02-module.categories/02-Variables/03-Other/01-variable.otherVariableA.md", - "02-module.categories/02-Variables/03-Other/02-variable.otherVariableB.md", - "02-module.categories/03-Functions/01-CategoryA/01-function.categoryFunctionA1.md", - "02-module.categories/03-Functions/01-CategoryA/02-function.categoryFunctionA2.md", - "02-module.categories/03-Functions/01-CategoryA/03-function.categoryFunctionA3.md", - "02-module.categories/03-Functions/02-CategoryB/01-function.categoryFunctionB2.md", - "02-module.categories/03-Functions/03-Other/01-function.otherFunctionA.md", - "02-module.categories/03-Functions/03-Other/02-function.otherFunctionB.md", - "03-module.modules_module_1/index.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/index.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/01-Namespaces/01-namespace.nestedNamespace/index.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/01-Namespaces/01-namespace.nestedNamespace/01-Variables/01-variable.nestedNamespaceVariable.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/02-Enumerations/01-enumeration.NamespaceEnum.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/03-Classes/01-class.NameSpaceClassA.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/04-Interfaces/01-interface.NamespaceInterface.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/05-Type Aliases/01-type-alias.NamespaceTypeLiteral.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/06-Variables/01-variable.namespaceVariableA.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/06-Variables/02-variable.namespaceVariableB.md", - "03-module.modules_module_1/01-Namespaces/02-namespace.someNameSpaceB/index.md", - "03-module.modules_module_1/02-Enumerations/01-enumeration.Module1EnumA.md", - "03-module.modules_module_1/02-Enumerations/02-enumeration.Module1EnumB.md", - "03-module.modules_module_1/03-Classes/01-class.Module1ClassA.md", - "03-module.modules_module_1/03-Classes/02-class.Module1ClassB.md", - "03-module.modules_module_1/04-Interfaces/01-interface.Module1InterfaceA.md", - "03-module.modules_module_1/04-Interfaces/02-interface.Module1InterfaceB.md", - "03-module.modules_module_1/05-Type Aliases/01-type-alias.Module1TypeLiteralA.md", - "03-module.modules_module_1/05-Type Aliases/02-type-alias.Module1TypeLiteralB.md", - "03-module.modules_module_1/06-Variables/01-variable.module1VariableA.md", - "03-module.modules_module_1/06-Variables/02-variable.module1VariableB.md", - "03-module.modules_module_1/07-Functions/01-function.module1FunctionA.md", - "03-module.modules_module_1/07-Functions/02-function.module1FunctionB.md", -] -`; - -exports[`Urls: (Multiple entrypoints) should get urls (excludeGroups=false, outputFileStrategy=modules, includeFileNumberPrefixes: true) 1`] = ` -[ - "README.md", - "01-modules.md", - "02-module.categories.md", - "03-module.modules_module_1/index.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/index.md", - "03-module.modules_module_1/01-Namespaces/01-namespace.someNameSpace/01-Namespaces/01-namespace.nestedNamespace.md", - "03-module.modules_module_1/01-Namespaces/02-namespace.someNameSpaceB.md", -] -`; - -exports[`Urls: (Multiple entrypoints) should get urls (excludeGroups=true, includeFileNumberPrefixes: true) 1`] = ` -[ - "README.md", - "01-modules.md", - "02-module.categories/index.md", - "02-module.categories/01-CategoryA/01-interface.CategoryInterfaceA1.md", - "02-module.categories/01-CategoryA/02-interface.CategoryInterfaceA2.md", - "02-module.categories/01-CategoryA/03-variable.categoryVariableA1.md", - "02-module.categories/01-CategoryA/04-variable.categoryVariableA2.md", - "02-module.categories/01-CategoryA/05-function.categoryFunctionA1.md", - "02-module.categories/01-CategoryA/06-function.categoryFunctionA2.md", - "02-module.categories/01-CategoryA/07-function.categoryFunctionA3.md", - "02-module.categories/02-CategoryB/01-variable.categoryVariableB1.md", - "02-module.categories/02-CategoryB/02-function.categoryFunctionB2.md", - "02-module.categories/03-Other/01-interface.OtherInterfaceA.md", - "02-module.categories/03-Other/02-variable.otherVariableA.md", - "02-module.categories/03-Other/03-variable.otherVariableB.md", - "02-module.categories/03-Other/04-function.otherFunctionA.md", - "02-module.categories/03-Other/05-function.otherFunctionB.md", - "03-module.modules_module_1/index.md", - "03-module.modules_module_1/01-someNameSpace/index.md", - "03-module.modules_module_1/01-someNameSpace/01-nestedNamespace/index.md", - "03-module.modules_module_1/01-someNameSpace/01-nestedNamespace/01-variable.nestedNamespaceVariable.md", - "03-module.modules_module_1/01-someNameSpace/02-enumeration.NamespaceEnum.md", - "03-module.modules_module_1/01-someNameSpace/03-class.NameSpaceClassA.md", - "03-module.modules_module_1/01-someNameSpace/04-interface.NamespaceInterface.md", - "03-module.modules_module_1/01-someNameSpace/05-type-alias.NamespaceTypeLiteral.md", - "03-module.modules_module_1/01-someNameSpace/06-variable.namespaceVariableA.md", - "03-module.modules_module_1/01-someNameSpace/07-variable.namespaceVariableB.md", - "03-module.modules_module_1/02-someNameSpaceB/index.md", - "03-module.modules_module_1/03-enumeration.Module1EnumA.md", - "03-module.modules_module_1/04-enumeration.Module1EnumB.md", - "03-module.modules_module_1/05-class.Module1ClassA.md", - "03-module.modules_module_1/06-class.Module1ClassB.md", - "03-module.modules_module_1/07-interface.Module1InterfaceA.md", - "03-module.modules_module_1/08-interface.Module1InterfaceB.md", - "03-module.modules_module_1/09-type-alias.Module1TypeLiteralA.md", - "03-module.modules_module_1/10-type-alias.Module1TypeLiteralB.md", - "03-module.modules_module_1/11-variable.module1VariableA.md", - "03-module.modules_module_1/12-variable.module1VariableB.md", - "03-module.modules_module_1/13-function.module1FunctionA.md", - "03-module.modules_module_1/14-function.module1FunctionB.md", -] -`; - -exports[`Urls: (Multiple entrypoints) should get urls (excludeGroups=true, outputFileStrategy=modules, includeFileNumberPrefixes: true, readme=none) 1`] = ` -[ - "README.md", - "01-module.categories.md", - "02-module.modules_module_1/index.md", - "02-module.modules_module_1/01-someNameSpace/index.md", - "02-module.modules_module_1/01-someNameSpace/01-nestedNamespace.md", - "02-module.modules_module_1/02-someNameSpaceB.md", -] -`; - -exports[`Urls: (Multiple entrypoints) should get urls (flattenOutputFiles=true) 1`] = ` -[ - "README.md", - "modules.md", - "modules_module-1.md", - "modules_module-1.Namespace.someNameSpace.md", - "modules_module-1.Namespace.someNameSpace.Namespace._nestedNamespace.md", - "modules_module-1.Namespace.someNameSpace.Namespace._nestedNamespace.Variable.nestedNamespaceVariable.md", - "modules_module-1.Namespace.someNameSpace.Enumeration.NamespaceEnum.md", - "modules_module-1.Namespace.someNameSpace.Class.NameSpaceClassA.md", - "modules_module-1.Namespace.someNameSpace.Interface.NamespaceInterface.md", - "modules_module-1.Namespace.someNameSpace.Type.NamespaceTypeLiteral.md", - "modules_module-1.Namespace.someNameSpace.Variable.namespaceVariableA.md", - "modules_module-1.Namespace.someNameSpace.Variable.namespaceVariableB.md", - "modules_module-1.Namespace.someNameSpaceB.md", - "modules_module-1.Enumeration.Module1EnumA.md", - "modules_module-1.Enumeration.Module1EnumB.md", - "modules_module-1.Class.Module1ClassA.md", - "modules_module-1.Class.Module1ClassB.md", - "modules_module-1.Interface.Module1InterfaceA.md", - "modules_module-1.Interface.Module1InterfaceB.md", - "modules_module-1.Type.Module1TypeLiteralA.md", - "modules_module-1.Type.Module1TypeLiteralB.md", - "modules_module-1.Variable.module1VariableA.md", - "modules_module-1.Variable.module1VariableB.md", - "modules_module-1.Function.module1FunctionA.md", - "modules_module-1.Function.module1FunctionB.md", - "reflections.md", - "reflections.Namespace.Duck.md", - "reflections.Namespace.Duck.Type.Age.md", - "reflections.Enumeration.EnumReflection.md", - "reflections.Class.Duck.md", - "reflections.Class.ImplementedClass.md", - "reflections.Class.ReflectionClass.md", - "reflections.Interface.CallableReflection.md", - "reflections.Interface.IndexableReflection.md", -] -`; - -exports[`Urls: (Single entrypoint) should get urls (excludeGroups=false, includeFileNumberPrefixes=true) 1`] = ` -[ - "README.md", - "01-exports.md", - "02-Interfaces/02-interface.CategoryInterfaceA1.md", - "02-Interfaces/03-interface.CategoryInterfaceA2.md", - "02-Interfaces/04-interface.OtherInterfaceA.md", - "03-Variables/02-variable.categoryVariableA1.md", - "03-Variables/03-variable.categoryVariableA2.md", - "03-Variables/04-variable.categoryVariableB1.md", - "03-Variables/05-variable.otherVariableA.md", - "03-Variables/06-variable.otherVariableB.md", - "04-Functions/02-function.categoryFunctionA1.md", - "04-Functions/03-function.categoryFunctionA2.md", - "04-Functions/04-function.categoryFunctionA3.md", - "04-Functions/05-function.categoryFunctionB2.md", - "04-Functions/06-function.otherFunctionA.md", - "04-Functions/07-function.otherFunctionB.md", -] -`; - -exports[`Urls: (Single entrypoint) should get urls (excludeGroups=true, includeFileNumberPrefixes=true, readme=none) 1`] = ` -[ - "README.md", - "01-interface.CategoryInterfaceA1.md", - "02-interface.CategoryInterfaceA2.md", - "03-interface.OtherInterfaceA.md", - "04-variable.categoryVariableA1.md", - "05-variable.categoryVariableA2.md", - "06-variable.categoryVariableB1.md", - "07-variable.otherVariableA.md", - "08-variable.otherVariableB.md", - "09-function.categoryFunctionA1.md", - "10-function.categoryFunctionA2.md", - "11-function.categoryFunctionA3.md", - "12-function.categoryFunctionB2.md", - "13-function.otherFunctionA.md", - "14-function.otherFunctionB.md", -] -`; - -exports[`Urls: (Single entrypoint) should get urls (flattenOutputFiles=true) 1`] = ` -[ - "README.md", - "exports.md", - "Namespace.Duck.md", - "Namespace.Duck.Type.Age.md", - "Enumeration.EnumReflection.md", - "Class.Duck.md", - "Class.ImplementedClass.md", - "Class.ReflectionClass.md", - "Interface.CallableReflection.md", - "Interface.IndexableReflection.md", -] -`; diff --git a/tools/typedoc-plugin-markdown/test/specs/breadcrumbs.spec.ts b/tools/typedoc-plugin-markdown/test/specs/breadcrumbs.spec.ts deleted file mode 100644 index 09c490da..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/breadcrumbs.spec.ts +++ /dev/null @@ -1,79 +0,0 @@ -import { ProjectReflection, Reflection } from 'typedoc'; - -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Breadcrumbs:`, () => { - let moduleReflection: Reflection; - let classReflection: Reflection; - - describe(`(with readme)`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['breadcrumbs.ts'])); - moduleReflection = (project.children as any)[0]; - classReflection = project.getChildByName('Breadcrumbs') as Reflection; - context.activeLocation = 'breadcrumbs.md'; - }); - - test(`should compile entryPoint (globals) breadcrumbs'`, () => { - expect( - context.partials.breadcrumbs({ - project: project, - model: project, - url: 'globals.md', - } as any), - ).toMatchSnapshot(); - }); - - test(`should compile module breadcrumbs'`, () => { - expect( - context.partials.breadcrumbs({ - project: project, - model: moduleReflection, - url: moduleReflection.url, - } as any), - ).toMatchSnapshot(); - }); - test(`should compile class breadcrumbs'`, () => { - expect( - context.partials.breadcrumbs({ - project: project, - model: classReflection, - url: classReflection.url, - } as any), - ).toMatchSnapshot(); - }); - }); - describe(`(without readme)`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['breadcrumbs.ts'], { - options: { readme: 'none' }, - })); - moduleReflection = (project.children as any)[0]; - classReflection = project.getChildByName('Breadcrumbs') as Reflection; - context.activeLocation = 'breadcrumbs.md'; - }); - - test(`should compile module breadcrumbs'`, () => { - expect( - context.partials.breadcrumbs({ - project: project, - model: moduleReflection, - url: moduleReflection.url, - } as any), - ).toMatchSnapshot(); - }); - test(`should compile class breadcrumbs'`, () => { - expect( - context.partials.breadcrumbs({ - project: project, - model: classReflection, - url: classReflection.url, - } as any), - ).toMatchSnapshot(); - }); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/categories.spec.ts b/tools/typedoc-plugin-markdown/test/specs/categories.spec.ts deleted file mode 100644 index ff98104b..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/categories.spec.ts +++ /dev/null @@ -1,79 +0,0 @@ -import { ProjectReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Categories:`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - - const baseOptions = { - hideKindTag: true, - disableSources: true, - outputFileStrategy: 'modules', - }; - - const stubbedPartials = [ - 'declarationMember', - 'reflectionMember', - 'signatureMember', - ]; - - describe(`(excludeGroups=false)`, () => { - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['categories.ts'], { - options: { - ...baseOptions, - excludeGroups: false, - }, - stubPartials: stubbedPartials, - })); - }); - - test(`should render category members'`, () => { - expect(context.partials.members(project, 2)).toMatchSnapshot(); - }); - - test(`should render category TOC'`, () => { - expect(context.partials.toc(project)).toMatchSnapshot(); - }); - }); - - describe(`(excludeGroups=true)`, () => { - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['categories.ts'], { - options: { - ...baseOptions, - excludeGroups: true, - }, - stubPartials: stubbedPartials, - })); - }); - - test(`should render category members'`, () => { - expect(context.partials.members(project, 2)).toMatchSnapshot(); - }); - - test(`should render category TOC'`, () => { - expect(context.partials.toc(project)).toMatchSnapshot(); - }); - }); - - describe(`(categorizeByGroup=false)`, () => { - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['categories.ts'], { - options: { - ...baseOptions, - categorizeByGroup: false, - }, - stubPartials: stubbedPartials, - })); - }); - - test(`should render category members'`, () => { - expect(context.partials.members(project, 2)).toMatchSnapshot(); - }); - - test(`should render category TOC'`, () => { - expect(context.partials.toc(project)).toMatchSnapshot(); - }); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/comments.spec.ts b/tools/typedoc-plugin-markdown/test/specs/comments.spec.ts deleted file mode 100644 index 67b1f910..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/comments.spec.ts +++ /dev/null @@ -1,48 +0,0 @@ -import { Comment, ProjectReflection } from 'typedoc'; - -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Comments:`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['comments.ts'], { - includes: './test/stubs/inc', - media: './test/stubs/media', - })); - }); - - test(`should convert symbols brackets to symbol links'`, () => { - context.activeLocation = 'comment.md'; - expect( - context.partials.comment( - project.getChildByName('commentsWithSymbolLinks')?.comment as Comment, - ), - ).toMatchSnapshot(); - }); - - test(`should convert comments with fenced block'`, () => { - expect( - context.partials.comment( - project.getChildByName('commentsWithFencedBlock')?.comment as Comment, - ), - ).toMatchSnapshot(); - }); - - test(`should convert comments with tags'`, () => { - expect( - context.partials.comment( - project.getChildByName('commentsWithTags')?.comment as Comment, - ), - ).toMatchSnapshot(); - }); - - test(`should escape angle brackets inside comments'`, () => { - expect( - context.partials.comment( - project.getChildByName('commentsWithMarkup')?.comment as Comment, - ), - ).toMatchSnapshot(); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/declarations.spec.ts b/tools/typedoc-plugin-markdown/test/specs/declarations.spec.ts deleted file mode 100644 index 50c0ff8a..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/declarations.spec.ts +++ /dev/null @@ -1,132 +0,0 @@ -import { ProjectReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Declarations:`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['declarations.ts'], { - stubPartials: ['sources'], - })); - context.activeLocation = 'declarations.md'; - }); - - test(`should compile a const with default value`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('stringConstWithDefaultValue') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile a let with default value`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('stringLetWithDefaultValue') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile an undefined declaration`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('undefinedNumberDeclaration') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile object literal declaration`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('objectLiteralDeclaration') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile object literal cast as a const`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('objectLiteralAsConstDeclaration') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile type literal declaration`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('typeLiteralDeclaration') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile declaration with double underscores in name and value`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('__DOUBLE_UNDERSCORES_DECLARATION__') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile any function type`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('AnyFunctionType') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile function declaration`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('functionDeclaration') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile indexable declaration`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('indexableDeclaration') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile enum declaration`, () => { - expect( - context.partials.declarationMember( - (project.getChildByName('EnumDeclarations') as any).children[0], - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile enum declaration with defaults`, () => { - expect( - context.partials.declarationMember( - (project.getChildByName('EnumDeclarationsWithDefaults') as any) - .children[0], - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile declaration with accessors`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('getterAndSetter') as any, - 2, - ), - ).toMatchSnapshot(); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/generics.spec.ts b/tools/typedoc-plugin-markdown/test/specs/generics.spec.ts deleted file mode 100644 index 55183c7e..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/generics.spec.ts +++ /dev/null @@ -1,68 +0,0 @@ -import { ProjectReflection, SignatureReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Generics:`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['generics.ts'], { - stubPartials: [ - 'breadcrumbs', - 'comment', - 'members', - 'sources', - 'toc', - 'pageHeader', - ], - })); - context.activeLocation = 'generics.md'; - }); - - test(`should compile class with type params`, () => { - expect( - context.templates.reflectionTemplate({ - model: project.getChildByName('ClassWithTypeParams'), - project: project, - } as any), - ).toMatchSnapshot(); - }); - - test(`should compile function with a simple type param'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithTypeParam') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile function with complex type params'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithTypeParams') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile type with nested generics'`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('nestedGenerics') as any, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile generics with defaults'`, () => { - expect( - context.partials.declarationMember( - project.getChildByName('genericsWithDefaults') as any, - 2, - ), - ).toMatchSnapshot(); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/groups.spec.ts b/tools/typedoc-plugin-markdown/test/specs/groups.spec.ts deleted file mode 100644 index 80dad727..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/groups.spec.ts +++ /dev/null @@ -1,57 +0,0 @@ -import { ProjectReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Groups:`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - - const baseOptions = { - hideKindTag: true, - disableSources: true, - outputFileStrategy: 'modules', - }; - - const stubbedPartials = [ - 'declarationMember', - 'reflectionMember', - 'signatureMember', - ]; - - describe(`(excludeGroups=false)`, () => { - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['groups.ts'], { - options: { - ...baseOptions, - excludeGroups: false, - }, - stubPartials: stubbedPartials, - })); - }); - test(`should render group members'`, () => { - expect(context.partials.members(project, 2)).toMatchSnapshot(); - }); - - test(`should render group TOC'`, () => { - expect(context.partials.toc(project)).toMatchSnapshot(); - }); - }); - - describe(`(excludeGroups=true)`, () => { - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['groups.ts'], { - options: { - ...baseOptions, - excludeGroups: true, - }, - stubPartials: stubbedPartials, - })); - }); - test(`should render group members'`, () => { - expect(context.partials.members(project, 2)).toMatchSnapshot(); - }); - - test(`should render group TOC'`, () => { - expect(context.partials.toc(project)).toMatchSnapshot(); - }); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/hierarchy.spec.ts b/tools/typedoc-plugin-markdown/test/specs/hierarchy.spec.ts deleted file mode 100644 index 17921a5f..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/hierarchy.spec.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { ProjectReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Hierarchy:`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['hierarchy.ts'], { - stubPartials: ['breadcrumbs', 'comment', 'members', 'sources', 'toc'], - })); - context.activeLocation = 'hierarchy.md'; - }); - test(`should compile type hierarchy`, () => { - const reflection = project.getChildByName('ParentClass'); - expect( - context.partials.hierarchy((reflection as any).typeHierarchy), - ).toMatchSnapshot(); - }); - - test(`should compile nested type hierarchy`, () => { - const reflection = project.getChildByName('ChildClassA'); - expect( - context.partials.hierarchy((reflection as any).typeHierarchy), - ).toMatchSnapshot(); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/navigation.spec.ts b/tools/typedoc-plugin-markdown/test/specs/navigation.spec.ts deleted file mode 100644 index 2816db89..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/navigation.spec.ts +++ /dev/null @@ -1,119 +0,0 @@ -describe(`Navigation:`, () => { - describe(`(Multiple entrypoints)`, () => { - test(`should get urls (excludeGroups=false)`, async () => { - const { project, context } = await global.bootstrap( - ['categories.ts', 'modules/module-1'], - { - options: { - excludeGroups: false, - }, - }, - ); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=false, includeFileNumberPrefixes: true)`, async () => { - const { project, context } = await global.bootstrap( - ['modules/module-1', 'categories.ts'], - { - options: { - excludeGroups: false, - includeFileNumberPrefixes: true, - }, - }, - ); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=false, outputFileStrategy=modules, includeFileNumberPrefixes: true)`, async () => { - const { project, context } = await global.bootstrap( - ['categories.ts', 'modules/module-1'], - { - options: { - excludeGroups: false, - outputFileStrategy: 'modules', - includeFileNumberPrefixes: true, - }, - }, - ); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=true, includeFileNumberPrefixes: true)`, async () => { - const { project, context } = await global.bootstrap( - ['modules/module-1', 'categories.ts'], - { - options: { - excludeGroups: true, - includeFileNumberPrefixes: true, - }, - }, - ); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=true, outputFileStrategy=modules, includeFileNumberPrefixes: true, readme=none)`, async () => { - const { project, context } = await global.bootstrap( - ['categories.ts', 'modules/module-1'], - { - options: { - readme: 'none', - excludeGroups: true, - outputFileStrategy: 'modules', - includeFileNumberPrefixes: true, - }, - }, - ); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - }); - - describe(`(Single entrypoint)`, () => { - test(`should get urls (excludeGroups=false, includeFileNumberPrefixes=true)`, async () => { - const { project, context } = await global.bootstrap(['categories.ts'], { - options: { - excludeGroups: false, - includeFileNumberPrefixes: true, - }, - }); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - test(`should get urls (excludeGroups=true, includeFileNumberPrefixes=true, readme=none)`, async () => { - const { project, context } = await global.bootstrap(['categories.ts'], { - options: { - readme: 'none', - excludeGroups: true, - includeFileNumberPrefixes: true, - }, - }); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - }); - - describe(`(Monorepo)`, () => { - test(`should get urls (entryPointStrategy=packages)`, async () => { - const { project, context } = await global.bootstrap( - ['monorepo/packages/*'], - { - options: { - entryPointStrategy: 'packages', - }, - }, - ); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - - test(`should get urls (entryPointStrategy=packages, includeFileNumberPrefixes=true)`, async () => { - const { project, context } = await global.bootstrap( - ['monorepo/packages/*'], - { - options: { - entryPointStrategy: 'packages', - includeFileNumberPrefixes: true, - }, - }, - ); - expect(context.theme.getNavigation(project)).toMatchSnapshot(); - }); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/signatures.spec.ts b/tools/typedoc-plugin-markdown/test/specs/signatures.spec.ts deleted file mode 100644 index 0588245a..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/signatures.spec.ts +++ /dev/null @@ -1,193 +0,0 @@ -import { ProjectReflection, SignatureReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Signatures:`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['signatures.ts'], { - stubPartials: ['sources'], - })); - context.activeLocation = 'signatures.md'; - }); - - test(`should compile callable signature'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('CallableSignature') as any).signatures[0], - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile signature with a flag'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('privateFunction') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile signature with params'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithParameters') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile function that returns an object'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionReturningAnObject') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile a promise that returns an object'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('promiseReturningAnObject') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile a promise that returns a symbol'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('promiseReturningASymbol') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile function that returns a function'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionReturningAFunction') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile signature with rest params'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithRest') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile signature with optional params'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithOptionalParam') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile signature with union types'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithUnionTypes') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile signature with default values'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithDefaults') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile signature with @return comments'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('commentsInReturn') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile named parameters'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithNamedParams') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile named parameters with comments'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithNamedParamsAndComments') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile pipes in params and comments'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithPipesInParamsAndComments') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile function with reference type'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithReferenceType') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile function with nested typen params'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('functionWithNestedParams') as any) - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); - - test(`should compile class with constructor'`, () => { - expect( - context.partials.signatureMember( - (project.getChildByName('ClassWithConstructor') as any).children[0] - .signatures[0] as SignatureReflection, - 2, - ), - ).toMatchSnapshot(); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/types.spec.ts b/tools/typedoc-plugin-markdown/test/specs/types.spec.ts deleted file mode 100644 index c93a6a00..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/types.spec.ts +++ /dev/null @@ -1,161 +0,0 @@ -import { ProjectReflection } from 'typedoc'; -import { MarkdownThemeRenderContext } from '../../src/theme-render-context'; - -describe(`Types:`, () => { - let project: ProjectReflection; - let context: MarkdownThemeRenderContext; - - beforeAll(async () => { - ({ project, context } = await global.bootstrap(['types.ts'])); - context.activeLocation = 'types.md'; - }); - - test(`should compile 'array' type'`, () => { - expect( - context.partials.someType( - (project.getChildByName('arrayType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile 'stringLiteral' type'`, () => { - expect( - context.partials.someType( - (project.getChildByName('stringLiteralType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile 'union' of string literals types'`, () => { - expect( - context.partials.someType( - (project.getChildByName('unionType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile 'union' of literal declarations`, () => { - expect( - context.partials.someType( - (project.getChildByName('unionTypeWithSymbolsDeclarations') as any) - .type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile intrinsic type'`, () => { - expect( - context.partials.someType( - (project.getChildByName('stringType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile collapsed 'literal' type'`, () => { - expect( - context.partials.someType( - (project.getChildByName('literalType') as any).type, - 'all', - ), - ).toMatchSnapshot(); - }); - - test(`should compile expanded 'literal' type'`, () => { - expect( - context.partials.someType( - (project.getChildByName('literalType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile collapsed 'objectLiteralType' type'`, () => { - expect( - context.partials.declarationType( - project.getChildByName('objectLiteralType') as any, - 'object', - ), - ).toMatchSnapshot(); - }); - - test(`should compile expanded 'objectLiteralType' type'`, () => { - expect( - context.partials.declarationType( - project.getChildByName('objectLiteralType') as any, - ), - ).toMatchSnapshot(); - }); - - test(`should compile 'tuple' type'`, () => { - expect( - context.partials.someType( - (project.getChildByName('tupleType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile 'intersection' type'`, () => { - expect( - context.partials.someType( - (project.getChildByName('intersectionType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile collapsed 'function' type '`, () => { - expect( - context.partials.someType( - (project.getChildByName('functionReflectionType') as any).type, - 'function', - ), - ).toMatchSnapshot(); - }); - - test(`should compile expanded 'function' type '`, () => { - expect( - context.partials.someType( - (project.getChildByName('functionReflectionType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile 'typeOperator' type '`, () => { - expect( - context.partials.someType( - (project.getChildByName('typeOperatorType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile unionType with object literal type '`, () => { - expect( - context.partials.someType( - (project.getChildByName('objectLiteralUnionType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should compile conditional type '`, () => { - expect( - context.partials.someType( - (project.getChildByName('ConditionalType') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should resolve external refs'`, () => { - expect( - context.partials.someType( - (project.getChildByName('externalReference') as any).type, - ), - ).toMatchSnapshot(); - }); - - test(`should resolve external refs with type params'`, () => { - expect( - context.partials.someType( - (project.getChildByName('externalReferenceInsideTypeParams') as any) - .type, - ), - ).toMatchSnapshot(); - }); -}); diff --git a/tools/typedoc-plugin-markdown/test/specs/urls.spec.ts b/tools/typedoc-plugin-markdown/test/specs/urls.spec.ts deleted file mode 100644 index 5b8c54c9..00000000 --- a/tools/typedoc-plugin-markdown/test/specs/urls.spec.ts +++ /dev/null @@ -1,163 +0,0 @@ -describe(`Urls:`, () => { - describe(`(Multiple entrypoints)`, () => { - test(`should get urls (excludeGroups=false)`, async () => { - const { project, context } = await global.bootstrap( - ['categories.ts', 'modules/module-1'], - { - options: { - excludeGroups: false, - }, - }, - ); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - - test(`should get urls (flattenOutputFiles=true)`, async () => { - const { project, context } = await global.bootstrap( - ['reflections.ts', 'modules/module-1'], - { - options: { - flattenOutputFiles: true, - }, - }, - ); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=false, includeFileNumberPrefixes: true)`, async () => { - const { project, context } = await global.bootstrap( - ['modules/module-1', 'categories.ts'], - { - options: { - excludeGroups: false, - includeFileNumberPrefixes: true, - }, - }, - ); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=false, outputFileStrategy=modules, includeFileNumberPrefixes: true)`, async () => { - const { project, context } = await global.bootstrap( - ['categories.ts', 'modules/module-1'], - { - options: { - excludeGroups: false, - outputFileStrategy: 'modules', - includeFileNumberPrefixes: true, - }, - }, - ); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=true, includeFileNumberPrefixes: true)`, async () => { - const { project, context } = await global.bootstrap( - ['modules/module-1', 'categories.ts'], - { - options: { - excludeGroups: true, - includeFileNumberPrefixes: true, - }, - }, - ); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=true, outputFileStrategy=modules, includeFileNumberPrefixes: true, readme=none)`, async () => { - const { project, context } = await global.bootstrap( - ['categories.ts', 'modules/module-1'], - { - options: { - readme: 'none', - excludeGroups: true, - outputFileStrategy: 'modules', - includeFileNumberPrefixes: true, - }, - }, - ); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - }); - - describe(`(Single entrypoint)`, () => { - test(`should get urls (excludeGroups=false, includeFileNumberPrefixes=true)`, async () => { - const { project, context } = await global.bootstrap(['categories.ts'], { - options: { - excludeGroups: false, - includeFileNumberPrefixes: true, - }, - }); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - - test(`should get urls (flattenOutputFiles=true)`, async () => { - const { project, context } = await global.bootstrap(['reflections.ts'], { - options: { - flattenOutputFiles: true, - }, - }); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - - test(`should get urls (excludeGroups=true, includeFileNumberPrefixes=true, readme=none)`, async () => { - const { project, context } = await global.bootstrap(['categories.ts'], { - options: { - readme: 'none', - excludeGroups: true, - includeFileNumberPrefixes: true, - }, - }); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - }); - - describe(`(Monorepo)`, () => { - test(`should get urls (entryPointStrategy=packages)`, async () => { - const { project, context } = await global.bootstrap( - ['monorepo/packages/*'], - { - options: { - entryPointStrategy: 'packages', - }, - }, - ); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - - test(`should get urls (entryPointStrategy=packages, includeFileNumberPrefixes=true)`, async () => { - const { project, context } = await global.bootstrap( - ['monorepo/packages/*'], - { - options: { - entryPointStrategy: 'packages', - includeFileNumberPrefixes: true, - }, - }, - ); - expect( - context.theme.getUrls(project).map((url) => url.url), - ).toMatchSnapshot(); - }); - }); -}); diff --git a/tools/typedoc-plugin-markdown/tsconfig.json b/tools/typedoc-plugin-markdown/tsconfig.json deleted file mode 100644 index 95fa80e6..00000000 --- a/tools/typedoc-plugin-markdown/tsconfig.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "extends": "../../tools/typedoc-tsconfig/tsconfig.json", - "compilerOptions": { - "outDir": "./dist" - }, - "exclude": ["./dist", "./test", "./scripts", "**/*.spec.ts"] -} diff --git a/tools/typedoc-plugin-markdown/tsconfig.test.json b/tools/typedoc-plugin-markdown/tsconfig.test.json deleted file mode 100644 index e8b15862..00000000 --- a/tools/typedoc-plugin-markdown/tsconfig.test.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "../../tools/typedoc-tsconfig/tsconfig.test.json" -} diff --git a/tools/typedoc-tsconfig/tsconfig.json b/tools/typedoc-tsconfig/tsconfig.json deleted file mode 100644 index 3b58b8c1..00000000 --- a/tools/typedoc-tsconfig/tsconfig.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "compilerOptions": { - "declaration": true, - "experimentalDecorators": true, - "esModuleInterop": true, - "lib": ["es2018", "dom"], - "module": "commonjs", - "moduleResolution": "node", - "noImplicitAny": false, - "noUnusedLocals": true, - "removeComments": true, - "sourceMap": false, - "strictNullChecks": true, - "target": "es2018" - } -} diff --git a/tools/typedoc-tsconfig/tsconfig.test.json b/tools/typedoc-tsconfig/tsconfig.test.json deleted file mode 100644 index 803fbf87..00000000 --- a/tools/typedoc-tsconfig/tsconfig.test.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "extends": "./tsconfig.json", - "compilerOptions": { - "noUnusedLocals": false, - "strictNullChecks": false - } -} diff --git a/tools/typedoc-vitepress-theme/.gitignore b/tools/typedoc-vitepress-theme/.gitignore deleted file mode 100644 index 5069cfc1..00000000 --- a/tools/typedoc-vitepress-theme/.gitignore +++ /dev/null @@ -1 +0,0 @@ -docs/api \ No newline at end of file diff --git a/tools/typedoc-vitepress-theme/CHANGELOG.md b/tools/typedoc-vitepress-theme/CHANGELOG.md deleted file mode 100644 index ef6bd09b..00000000 --- a/tools/typedoc-vitepress-theme/CHANGELOG.md +++ /dev/null @@ -1,12 +0,0 @@ -# typedoc-vitepress-theme - -## 1.0.0-next.0 (2023-05-13) - -### Major Changes - -- Initial commit - -### Patch Changes - -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.11 diff --git a/tools/typedoc-vitepress-theme/LICENSE b/tools/typedoc-vitepress-theme/LICENSE deleted file mode 100644 index a5e32ed9..00000000 --- a/tools/typedoc-vitepress-theme/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2020 Thomas Grey - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/tools/typedoc-vitepress-theme/README.md b/tools/typedoc-vitepress-theme/README.md deleted file mode 100644 index b0c45710..00000000 --- a/tools/typedoc-vitepress-theme/README.md +++ /dev/null @@ -1,165 +0,0 @@ -# typedoc-vitepress-theme - -A [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-plugin-markdown/README.md) theme that publishes Markdown pages compatible with [VitePress](https://vitepress.dev/). - -[![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg)](https://www.npmjs.com/package/typedoc-vitepress-theme) -![CI](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master) - -## What does it do? - -- Presets relevant options of [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown#readme) targetting VitePress Markdown. -- Auto generates a VitePress sidebar that can be referenced from the VitePress config. - -## What about VuePress? - -This theme is also compatible with VuePress and the configuration is almost identical. However this theme supersedes previous VuePress TypeDoc plugins and is specifically targetted for VitePress. - -See https://vitepress.dev/guide/what-is-vitepress#what-about-vuepress. - -## Installation - -### 1. Install VitePress - -https://vitepress.dev/guide/getting-started - -### 2. Install plugin - -> Install the plugin in the same location as your VitePress installation. - -> [typedoc](https://github.com/TypeStrong/typedoc) and [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown) are required peer dependencies. - -```shell -npm install typedoc typedoc-plugin-markdown@next typedoc-vitepress-theme@next --save-dev -``` - -### Typical file structure - -``` -. -├─ docs -│ ├─ .vitepress -│ │ └─ config.js -│ └─ api (default out dir containing generated TypeDoc pages and typedoc-sidebar.json file) -└─ package.json (package.json project root) -``` - -## Usage - -Create a script that builds TypeDoc pages before bootstraping VitePress. The following is a guideline only and can be tailored as required. - -### 1. Create a script to publish TypeDoc pages - -```js -"publish-typedoc": "typedoc --options typedoc.json" -``` - -**typedoc.json** - -```json -{ - "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"] -} -``` - -### 2. Run the script before bootstrapping VitePress - -```json -"docs:dev": "npm run publish-typedoc && vitepress dev docs", -"docs:build": "npm run publish-typedoc && vitepress build docs" -``` - -### 3. Configure Navbar and Sidebar - -A sidebar named `typedoc-sidebar.json` is auto-generated to the out directory. This can then be referenced in the config file to configure the sidebar. - -**docs/.vitepress/config.ts** - -```js -import typedocSidebar from '../api/typedoc-sidebar.json'; - -module.exports = { - themeConfig: { - nav: [{ text: 'API', link: '/api/' }], - sidebar: [ - { - text: 'API', - items: typedocSidebar, - }, - ], - }, -}; -``` - -## Options - -Options can be declared: - -- Passing arguments via the command line. -- Using a `typedoc.json` file. -- Under the `typedocOptions` key in `tsconfig.json`. - -Please see https://typedoc.org/options/configuration for general TypeDoc option configuration. - -### TypeDoc options - -The following TypeDoc / Markdown plugin options can be passed to config: - -- [typedoc options](https://typedoc.org/options) (HTML specific output options that will be ignored). -- [typedoc-plugin-markdown options](https://typedoc.org/options) (Some options are already preset to target VitePress). - -The following typedoc-plugin-markdown options are preset with the theme. - -```json -{ - "anchorFormat": "slug", - "entryDocument": "index.md", - "hideBreadcrumbs": true, - "hidePageHeader": true, - "out": "./docs/api" -} -``` - -### Theme options - -The following theme options are also exposed, but the defaults should work for most use cases. - -#### `--sidebar` - -`sidebar.autoConfiguration` - -Set to `false` to disable sidebar generation. Defaults to `true`. - -`sidebar.format` - -The format of the sidebar. This option is exposed to enable backward compatibility with VuePress sidebars. Available options [`vitepress` `vuepress1`, `vuepress2`]. Defaults to `vitepress`. - -```json -{ - "sidebar": { - "autoConfiguration": true, - "format": "vitepress" - } -} -``` - -#### `--docsRoot` - -The VitePress docs folder root. Use `./` if no root folder specified. Defaults to `./docs`. - -```shell ---docsRoot -``` - -## Frontmatter - -Frontmatter can be added to pages by installing [typedoc-plugin-frontmatter](https://github.com/tgreyuk/typedoc-plugin-frontmatter#typedoc-plugin-frontmatter) and adding to the plugin list. - -```json -{ - "plugin": [..., "typedoc-plugin-frontmatter"] -} -``` - -## License - -[MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/vuepress-plugin-typedoc/LICENSE) diff --git a/tools/typedoc-vitepress-theme/jest.config.js b/tools/typedoc-vitepress-theme/jest.config.js deleted file mode 100644 index 350d0e4a..00000000 --- a/tools/typedoc-vitepress-theme/jest.config.js +++ /dev/null @@ -1,7 +0,0 @@ -const base = require('../../jest.config.base.js'); - -module.exports = { - ...base, - name: 'vuepress-plugin-typedoc', - displayName: 'vuepress-plugin-typedoc', -}; diff --git a/tools/typedoc-vitepress-theme/package.json b/tools/typedoc-vitepress-theme/package.json deleted file mode 100644 index d94f9ff2..00000000 --- a/tools/typedoc-vitepress-theme/package.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "name": "typedoc-vitepress-theme", - "version": "1.0.0-next.0", - "description": "A typedoc-plugin-markdown theme that publishes Markdown pages compatible with VitePress.", - "main": "./dist/index.js", - "files": [ - "dist/" - ], - "bugs": { - "url": "https://github.com/tgreyuk/typedoc-plugin-markdown/issues" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/tgreyuk/typedoc-vitepress-theme.git", - "directory": "packages/typedoc-vuepress-theme" - }, - "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-vitepress-theme", - "author": "Thomas Grey", - "scripts": { - "lint": "eslint ./src --ext .ts", - "prepublishOnly": "npm run lint && npm run build", - "build": "rm -rf ./dist && tsc", - "predocs": "npm run build", - "docs": "typedoc --options ../../stubs/typedoc.1.js --plugin typedoc-plugin-markdown --plugin ./dist --out docs", - "docs:dev": "vitepress dev docs", - "docs:build": "vitepress build docs", - "docs:preview": "vitepress preview docs" - }, - "peerDependencies": { - "typedoc-plugin-markdown": "workspace:*" - }, - "license": "MIT", - "keywords": [ - "vuepress", - "typedoc" - ] -} diff --git a/tools/typedoc-vitepress-theme/src/index.ts b/tools/typedoc-vitepress-theme/src/index.ts deleted file mode 100644 index 51c21461..00000000 --- a/tools/typedoc-vitepress-theme/src/index.ts +++ /dev/null @@ -1,57 +0,0 @@ -import * as fs from 'fs'; -import * as path from 'path'; -import { Application, ParameterType } from 'typedoc'; -import { - MarkdownPluginOptionsReader, - MarkdownRendererEvent, -} from 'typedoc-plugin-markdown'; -import { SidebarOptions } from './model'; -import { DEFAULT_SIDEBAR_OPTIONS } from './options'; -import { getSidebar } from './sidebars/sidebars'; - -export function load(app: Application) { - app.options.addDeclaration({ - name: 'docsRoot', - help: '', - type: ParameterType.Path, - defaultValue: './docs', - }); - - app.options.addDeclaration({ - name: 'sidebar', - help: '', - type: ParameterType.Mixed, - defaultValue: DEFAULT_SIDEBAR_OPTIONS, - }); - - app.options.addReader( - new MarkdownPluginOptionsReader({ - anchorFormat: 'slug', - entryDocument: 'index.md', - hideBreadcrumbs: true, - hidePageHeader: true, - out: './docs/api', - }), - ); - - app.renderer.postRenderAsyncJobs.push( - async (output: MarkdownRendererEvent) => { - const sidebarOptions = { - ...DEFAULT_SIDEBAR_OPTIONS, - ...(app.options.getValue('sidebar') as SidebarOptions), - }; - if (sidebarOptions.autoConfiguration) { - const outDir = app.options.getValue('out') as string; - const sourceDir = app.options.getValue('docsRoot') as string; - const sidebarPath = path.resolve(outDir, 'typedoc-sidebar.json'); - const basePath = path.relative(sourceDir, outDir); - const sidebarJson = getSidebar( - output.navigation, - basePath, - sidebarOptions, - ); - fs.writeFileSync(sidebarPath, JSON.stringify(sidebarJson)); - } - }, - ); -} diff --git a/tools/typedoc-vitepress-theme/src/model.ts b/tools/typedoc-vitepress-theme/src/model.ts deleted file mode 100644 index 8ad1a312..00000000 --- a/tools/typedoc-vitepress-theme/src/model.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface SidebarOptions { - autoConfiguration: boolean; - format: 'vitepress' | 'vuepress1' | 'vuepress2'; -} diff --git a/tools/typedoc-vitepress-theme/src/options.ts b/tools/typedoc-vitepress-theme/src/options.ts deleted file mode 100644 index 872c9ee7..00000000 --- a/tools/typedoc-vitepress-theme/src/options.ts +++ /dev/null @@ -1,4 +0,0 @@ -export const DEFAULT_SIDEBAR_OPTIONS = { - autoConfiguration: true, - format: 'vitepress', -}; diff --git a/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vitepress.ts b/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vitepress.ts deleted file mode 100644 index cd0d7a15..00000000 --- a/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vitepress.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { NavigationItem } from 'typedoc-plugin-markdown'; - -export = (navigation: NavigationItem[], basePath: string) => { - return navigation.map((navigationItem) => { - return getNavigationItem(navigationItem, basePath); - }); -}; - -function getNavigationItem(navigationItem: NavigationItem, basePath: string) { - return { - text: navigationItem.title, - link: navigationItem.url ? `/${basePath}/${navigationItem.url}` : null, - collapsed: true, - items: navigationItem.children?.map((group) => { - return getNavigationItem(group, basePath); - }), - }; -} diff --git a/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vuepress1.ts b/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vuepress1.ts deleted file mode 100644 index 4ccbf4ec..00000000 --- a/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vuepress1.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { NavigationItem } from 'typedoc-plugin-markdown'; - -export = (navigation: NavigationItem[], basePath: string) => { - return navigation?.map((navigationItem) => { - return getNavigationItem(navigationItem, basePath); - }); -}; - -function getNavigationItem(navigationItem: NavigationItem, basePath: string) { - return { - title: navigationItem.title, - sidebarDepth: 0, - path: navigationItem.url - ? `/${basePath}/${getUrlKey(navigationItem.url as string)}` - : null, - children: navigationItem.children?.map((groupChild) => { - return getNavigationItem(groupChild, basePath); - }), - }; -} - -function getUrlKey(url: string) { - return url.replace('.md', ''); -} diff --git a/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vuepress2.ts b/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vuepress2.ts deleted file mode 100644 index 2a39a19d..00000000 --- a/tools/typedoc-vitepress-theme/src/sidebars/sidebar.vuepress2.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { NavigationItem } from 'typedoc-plugin-markdown'; - -export = (navigation: NavigationItem[], basePath: string) => { - return navigation.map((navigationItem) => { - return getNavigationItem(navigationItem, basePath); - }); -}; - -function getNavigationItem(navigationItem: NavigationItem, basePath: string) { - return { - text: navigationItem.title, - link: navigationItem.url ? `/${basePath}/${navigationItem.url}` : null, - collapsible: true, - children: navigationItem.children?.map((group) => { - return getNavigationItem(group, basePath); - }), - }; -} diff --git a/tools/typedoc-vitepress-theme/src/sidebars/sidebars.ts b/tools/typedoc-vitepress-theme/src/sidebars/sidebars.ts deleted file mode 100644 index 40d90fae..00000000 --- a/tools/typedoc-vitepress-theme/src/sidebars/sidebars.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { NavigationItem } from 'typedoc-plugin-markdown'; -import { SidebarOptions } from '../model'; -import sidebarVitepress from './sidebar.vitepress'; -import sidebarVuepress1 from './sidebar.vuepress1'; -import sidebarVuepress2 from './sidebar.vuepress2'; - -export function getSidebar( - navigation: NavigationItem[], - basePath: string, - options: SidebarOptions, -) { - if (options.format === 'vuepress1') { - return sidebarVuepress1(navigation, basePath); - } - if (options.format === 'vuepress2') { - return sidebarVuepress2(navigation, basePath); - } - return sidebarVitepress(navigation, basePath); -} diff --git a/tools/typedoc-vitepress-theme/tsconfig.json b/tools/typedoc-vitepress-theme/tsconfig.json deleted file mode 100644 index c222f726..00000000 --- a/tools/typedoc-vitepress-theme/tsconfig.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "../../tools/typedoc-tsconfig/tsconfig.json", - "compilerOptions": { - "outDir": "./dist", - "esModuleInterop": true - }, - "exclude": ["./dist", "./test", "**/*.spec.ts"] -} diff --git a/tools/typedoc-vitepress-theme/typedoc.json b/tools/typedoc-vitepress-theme/typedoc.json deleted file mode 100644 index de947507..00000000 --- a/tools/typedoc-vitepress-theme/typedoc.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "entryPoints": [ - "../../../stubs/src/classes.ts", - "../../stubs/src/comments.ts" - ], - "tsconfig": "../../../stubs/tsconfig.json", - "plugin": ["typedoc-plugin-markdown", "../dist"], - "sidebar": { "version": "v1" } -} diff --git a/tools/webpack-siyuan-plugin/package.json b/tools/webpack-siyuan-plugin/package.json deleted file mode 100644 index f912f23c..00000000 --- a/tools/webpack-siyuan-plugin/package.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "name": "@terwer/webpack-siyuan-plugin", - "version": "0.0.1", - "description": "This is a sample plugin for Siyuan (https://b3log.org/siyuan)", - "keywords": [ - "webpack", - "siyuan", - "plugin" - ], - "author": "Vanessa", - "license": "MIT", - "peerDependencies": { - "copy-webpack-plugin": "^11.0.0", - "css-loader": "^6.7.1", - "esbuild-loader": "^3.0.1", - "mini-css-extract-plugin": "2.3.0", - "sass": "^1.62.1", - "sass-loader": "^12.6.0", - "siyuan": "latest", - "stylus": "^0.59.0", - "stylus-loader": "^7.1.0", - "tslib": "2.4.0", - "typescript": "4.7.4", - "webpack": "^5.76.0", - "webpack-cli": "^5.0.2", - "zip-webpack-plugin": "^4.0.1" - }, - "publishConfig": { - "access": "public" - } -}