diff --git a/devdocs-json.json b/devdocs-json.json deleted file mode 100644 index c69ef1ca..00000000 --- a/devdocs-json.json +++ /dev/null @@ -1,22534 +0,0 @@ -{ - "id": 0, - "name": "packages-example", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1, - "name": "typedoc-plugin-markdown", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 2, - "name": "app", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all the events and overrides of the typedoc Application." - } - ] - }, - "children": [ - { - "id": 3, - "name": "initialize", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialization and bootstrapping of the plugin." - } - ] - }, - "children": [ - { - "id": 4, - "name": "load", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/_initialize.ts", - "line": 49, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L49" - } - ], - "signatures": [ - { - "id": 5, - "name": "load", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is exposed to the " - }, - { - "kind": "code", - "text": "`\"plugin\"`" - }, - { - "kind": "text", - "text": " configuration option and contains all initialization functionality." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "The following initialization steps are taken in this method:\n\n**1. Declare options:**\n\n- Iterate over declaration definitions and to the container.\n\n**2. Replace default theme:**\n\n- Replace the default HTML theme the with the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "MarkdownTheme", - "target": 660, - "tsLinkText": "" - }, - { - "kind": "text", - "text": "\n\n**3. Override TypeDoc methods:**\n\n- Intercept and modify some TypeDoc core methods that are coupled to the HTML theme.\n**4. Configure localization:**\n\n- Load the additional translations used by the theme for the selected language." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://typedoc.org/guides/development/#plugins." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/_initialize.ts", - "line": 49, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L49" - } - ], - "parameters": [ - { - "id": 6, - "name": "app", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When loaded TypeDoc provides an instance of the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "Application", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/application.d.ts", - "qualifiedName": "Application" - }, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " referred to as the " - }, - { - "kind": "code", - "text": "`\"pluginHost\"`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/application.d.ts", - "qualifiedName": "Application" - }, - "name": "Application", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 4 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/_initialize.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L1" - } - ] - }, - { - "id": 7, - "name": "events", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all the events and overrides of the typedoc Application." - } - ] - }, - "children": [ - { - "id": 8, - "name": "MarkdownPageEvent", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An event emitted by before and after the markup of a page is rendered." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nexport function load(app: MarkdownApplication) {\n app.renderer.on(MarkdownPageEvent.BEGIN, (page: MarkdownPageEvent) => {\n page.contents = page.contents.replace('foo', 'bar');\n });\n});\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 9, - "name": "project", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "ProjectReflection", - "target": "https://typedoc.org/api/classes/Models.ProjectReflection.html" - }, - { - "kind": "text", - "text": " instance the renderer is currently processing." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 23, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L23" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - }, - { - "id": 10, - "name": "model", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The model that that is being rendered on this page.\nEither a " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "DeclarationReflection", - "target": "https://typedoc.org/api/classes/Models.DeclarationReflection.html" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "ProjectReflection", - "target": "https://typedoc.org/api/classes/Models.ProjectReflection.html" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 29, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L29" - } - ], - "type": { - "type": "reference", - "target": 17, - "name": "Model", - "package": "typedoc-plugin-markdown", - "qualifiedName": "MarkdownPageEvent.Model", - "refersToTypeParameter": true - } - }, - { - "id": 11, - "name": "contents", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The final markdown " - }, - { - "kind": "code", - "text": "`string`" - }, - { - "kind": "text", - "text": " content of the page.\n\nShould be rendered by layout templates and can be modified by plugins." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 36, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 12, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The url " - }, - { - "kind": "code", - "text": "`string`" - }, - { - "kind": "text", - "text": " of the page." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 41, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L41" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 13, - "name": "filename", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The complete " - }, - { - "kind": "code", - "text": "`string`" - }, - { - "kind": "text", - "text": " filename where the file will be written.." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 46, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L46" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 14, - "name": "frontmatter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The frontmatter of this page represented as a key value object. This property can be utilised by other plugins." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 51, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L51" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 15, - "name": "BEGIN", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Triggered before a document will be rendered." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 63, - "character": 18, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L63" - } - ], - "type": { - "type": "literal", - "value": "beginPage" - }, - "defaultValue": "'beginPage'" - }, - { - "id": 16, - "name": "END", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Triggered after a document has been rendered, just before it is written to disc." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 69, - "character": 18, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L69" - } - ], - "type": { - "type": "literal", - "value": "endPage" - }, - "defaultValue": "'endPage'" - } - ], - "groups": [ - { - "title": "Events", - "children": [ - 15, - 16 - ] - }, - { - "title": "Properties", - "children": [ - 9, - 10, - 11, - 12, - 13, - 14 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "line": 17, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L17" - } - ], - "typeParameters": [ - { - "id": 17, - "name": "Model", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/events.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typedoc" - } - ] - }, - { - "id": 18, - "name": "MarkdownRendererEvent", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An event emitted at the beginning and end of the rendering process.\n\n" - }, - { - "kind": "code", - "text": "```ts\napp.renderer.on(MarkdownRendererEvent.BEGIN, (event) => {\n console.log(`Render Starting for ${event.project.name}!`);\n});\n```" - } - ] - }, - "children": [ - { - "id": 19, - "name": "project", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The project the renderer is currently processing." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "line": 20, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L20" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - }, - { - "id": 20, - "name": "outputDirectory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path of the directory the documentation should be written to." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "line": 25, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L25" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 21, - "name": "urls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all pages that should be generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "line": 30, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L30" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 697, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "UrlMapping", - "package": "typedoc-plugin-markdown" - } - } - }, - { - "id": 22, - "name": "navigation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The navigation structure of the project that can be utilised by plugins." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "line": 35, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L35" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 705, - "name": "NavigationItem", - "package": "typedoc-plugin-markdown" - } - } - }, - { - "id": 23, - "name": "BEGIN", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Triggered before the renderer starts rendering a project." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "line": 41, - "character": 18, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L41" - } - ], - "type": { - "type": "literal", - "value": "beginRender" - }, - "defaultValue": "'beginRender'" - }, - { - "id": 24, - "name": "END", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Triggered after the renderer has written all documents." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "line": 47, - "character": 18, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L47" - } - ], - "type": { - "type": "literal", - "value": "endRender" - }, - "defaultValue": "'endRender'" - } - ], - "groups": [ - { - "title": "Events", - "children": [ - 23, - 24 - ] - }, - { - "title": "Properties", - "children": [ - 19, - 20, - 21, - 22 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "line": 16, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L16" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/events.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typedoc" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [ - 8, - 18 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/events/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/events/index.ts#L1" - } - ] - }, - { - "id": 25, - "name": "renderer", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains override methods to decouple HTML logic from the TypeDoc's Renderer}" - } - ] - }, - "children": [ - { - "id": 26, - "name": "generateDocs", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "line": 26, - "character": 22, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L26" - } - ], - "signatures": [ - { - "id": 27, - "name": "generateDocs", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Replacement of TypeDoc's " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "Application.generateDocs", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/application.d.ts", - "qualifiedName": "Application.generateDocs" - }, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method to decouple HTML logic." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "line": 26, - "character": 22, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L26" - } - ], - "parameters": [ - { - "id": 28, - "name": "project", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - }, - { - "id": 29, - "name": "out", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 30, - "name": "render", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "line": 48, - "character": 22, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L48" - } - ], - "signatures": [ - { - "id": 31, - "name": "render", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Replacement of TypeDoc's " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "Renderer.render", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/output/renderer.d.ts", - "qualifiedName": "Renderer.render" - }, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method to decouple HTML logic.\n\nThis is essentially a copy of the base method with a few tweaks.\n\n- Removes unnecessary async calls to load highlighters only required for html theme.\n- Removes hooks logic that are jsx specific.\n- Adds any logic specific to markdown rendering." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "line": 48, - "character": 22, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L48" - } - ], - "parameters": [ - { - "id": 32, - "name": "project", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - }, - { - "id": 33, - "name": "outputDirectory", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 34, - "name": "resolvePackages", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "line": 145, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L145" - } - ], - "signatures": [ - { - "id": 35, - "name": "resolvePackages", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Currently options set for packages are only stored on the converter and are destroyed before being passed to the Renderer.\n\nBy intercepting the package options set in the converter and storing them on the renderer we can use them later in the theme." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "line": 145, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L145" - } - ], - "parameters": [ - { - "id": 36, - "name": "app", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/application.d.ts", - "qualifiedName": "Application" - }, - "name": "Application", - "package": "typedoc" - } - }, - { - "id": 37, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/converter/context.d.ts", - "qualifiedName": "Context" - }, - "name": "Context", - "package": "typedoc" - } - }, - { - "id": 38, - "name": "packageDir", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 26, - 30, - 34 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/renderer.ts#L1" - } - ] - }, - { - "id": 39, - "name": "types", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Types used for the app." - } - ] - }, - "children": [ - { - "id": 40, - "name": "MarkdownApplication", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This interface is essentially an extended typing of TypeDoc's " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "Application", - "target": "https://typedoc.org/api/classes/Application.html" - }, - { - "kind": "text", - "text": " instance." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { MarkdownApplication } from 'typedoc-plugin-markdown';\n\nexport function load(app: MarkdownApplication) {\n ...\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 41, - "name": "renderer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Re-types the " - }, - { - "kind": "code", - "text": "`renderer`" - }, - { - "kind": "text", - "text": " instance to " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "MarkdownRenderer", - "target": 48, - "tsLinkText": "" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts", - "line": 22, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts#L22" - } - ], - "type": { - "type": "reference", - "target": 48, - "name": "MarkdownRenderer", - "package": "typedoc-plugin-markdown" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Application.renderer" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 41 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts", - "line": 18, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts#L18" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/application.d.ts", - "qualifiedName": "Application" - }, - "name": "Application", - "package": "typedoc" - } - ] - }, - { - "id": 42, - "name": "MarkdownRendererHooks", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Describes the hooks available to inject output in the markdown theme." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n app.renderer.markdownHooks.on(\n 'page.end',\n () => `**Generated using \\`page.end\\` hook**`,\n);\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 43, - "name": "page.begin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Applied at the start of the markdown output." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "line": 22, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L22" - } - ], - "type": { - "type": "tuple", - "elements": [ - { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - ] - } - }, - { - "id": 44, - "name": "page.end", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Applied at the end of the markdown output." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "line": 29, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L29" - } - ], - "type": { - "type": "tuple", - "elements": [ - { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - ] - } - }, - { - "id": 45, - "name": "content.begin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Applied before the main markdown content is rendered." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "line": 36, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L36" - } - ], - "type": { - "type": "tuple", - "elements": [ - { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - ] - } - }, - { - "id": 46, - "name": "index.page.begin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Applied at the start of the markdown output on the index page." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "line": 43, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L43" - } - ], - "type": { - "type": "tuple", - "elements": [ - { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - ] - } - }, - { - "id": 47, - "name": "index.page.end", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Applied at the end of the markdown output on the index page." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "line": 50, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L50" - } - ], - "type": { - "type": "tuple", - "elements": [ - { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - ] - } - } - ], - "groups": [ - { - "title": "Hooks", - "children": [ - 43, - 44, - 45, - 46, - 47 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "line": 16, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L16" - } - ] - }, - { - "id": 48, - "name": "MarkdownRenderer", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An extended typing of TypeDoc's " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "Renderer", - "target": "https://typedoc.org/api/classes/Renderer.html" - }, - { - "kind": "text", - "text": " class that includes updated typings for hooks and async jobs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { MarkdownApplication } from 'typedoc-plugin-markdown';\n\nexport function load(app: MarkdownApplication) {\n\napp.renderer.markdownHooks.on(\n 'page.begin', () => '> This is some markdown at the top of the page',\n);\n\napp.renderer.preRenderAsyncJobs.push(async (output: MarkdownRendererEvent) => {\n await doSomethingAsync(output);\n});\n\napp.renderer.postRenderAsyncJobs.push(async (output: MarkdownRendererEvent)) => {\n await doSomethingAsync(output);\n});\n\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 49, - "name": "markdownHooks", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Replaces the event hooks typings the " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "MarkdownRendererHooks", - "target": 42, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " used by the plugin." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 36, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L36" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/hooks.d.ts", - "qualifiedName": "EventHooks" - }, - "typeArguments": [ - { - "type": "reference", - "target": 42, - "name": "MarkdownRendererHooks", - "package": "typedoc-plugin-markdown" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "EventHooks", - "package": "typedoc" - } - }, - { - "id": 50, - "name": "packagesMeta", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 38, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L38" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 51, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 52, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 38, - "character": 33, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 53, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 38, - "character": 54, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L38" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/options.d.ts", - "qualifiedName": "Options" - }, - "name": "Options", - "package": "typedoc" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 52, - 53 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 38, - "character": 31, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L38" - } - ] - } - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 54, - "name": "defineTheme", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 40, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L40" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 55, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 40, - "character": 15, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L40" - } - ], - "signatures": [ - { - "id": 56, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 40, - "character": 15, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L40" - } - ], - "parameters": [ - { - "id": 57, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 58, - "name": "theme", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 59, - "name": "__type", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 42, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L42" - } - ], - "signatures": [ - { - "id": 60, - "name": "new theme", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 42, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L42" - } - ], - "parameters": [ - { - "id": 61, - "name": "renderer", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 48, - "name": "MarkdownRenderer", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "reference", - "target": 660, - "name": "MarkdownTheme", - "package": "typedoc-plugin-markdown" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Renderer.defineTheme" - } - }, - { - "id": 62, - "name": "preRenderAsyncJobs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Re-types the returned argument argument to " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "MarkdownRendererEvent", - "target": 18, - "tsLinkText": "" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 47, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L47" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 63, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 47, - "character": 28, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L47" - } - ], - "signatures": [ - { - "id": 64, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 47, - "character": 28, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L47" - } - ], - "parameters": [ - { - "id": 65, - "name": "output", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 18, - "name": "MarkdownRendererEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Renderer.preRenderAsyncJobs" - } - }, - { - "id": 66, - "name": "postRenderAsyncJobs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Re-types the returned argument argument to " - }, - { - "kind": "inline-tag", - "tag": "@linkcode", - "text": "MarkdownRendererEvent", - "target": 18, - "tsLinkText": "" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 51, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L51" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 51, - "character": 29, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L51" - } - ], - "signatures": [ - { - "id": 68, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 51, - "character": 29, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L51" - } - ], - "parameters": [ - { - "id": 69, - "name": "output", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 18, - "name": "MarkdownRendererEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Renderer.postRenderAsyncJobs" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 49, - 50, - 54, - 62, - 66 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "line": 32, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L32" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/output/renderer.d.ts", - "qualifiedName": "Renderer" - }, - "name": "Renderer", - "package": "typedoc" - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 40, - 42, - 48 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/types/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/types/index.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Namespaces", - "children": [ - 3, - 7, - 25, - 39 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/app/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/app/index.ts#L1" - } - ] - }, - { - "id": 70, - "name": "options", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configures plugin options." - } - ] - }, - "children": [ - { - "id": 71, - "name": "constants", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains constant default values used in options." - } - ] - }, - "children": [ - { - "id": 72, - "name": "ALLOWED_OWN_FILE_MEMBERS", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 9, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L9" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 73, - "name": "TEXT_CONTENT_MAPPINGS", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 18, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L18" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 74, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 75, - "name": "header.title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 19, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'{projectName} {version}'" - }, - { - "id": 76, - "name": "header.docs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 20, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L20" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'Docs'" - }, - { - "id": 77, - "name": "breadcrumbs.home", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 21, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'{projectName} {version}'" - }, - { - "id": 78, - "name": "title.indexPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 22, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L22" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'{projectName} {version}'" - }, - { - "id": 79, - "name": "title.memberPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 23, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L23" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'{kind}: {name}'" - }, - { - "id": 80, - "name": "footer.text", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 24, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 75, - 76, - 77, - 78, - 79, - 80 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 18, - "character": 37, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L18" - } - ] - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Variables", - "children": [ - 72, - 73 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/constants.ts#L1" - } - ] - }, - { - "id": 81, - "name": "declarations", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Typedoc options declarations.\nEach exported variable will be added to the TypeDoc options and also the public documentation." - } - ] - }, - "children": [ - { - "id": 82, - "name": "outputFileStrategy", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "TypeDoc creates documentation according to exports derived from the given [" - }, - { - "kind": "code", - "text": "`entryPointsStrategy`" - }, - { - "kind": "text", - "text": "](https://typedoc.org/options/input/#entrypointstrategy) configuration.\n\nThis option does not alter the way TypeDoc interprets the " - }, - { - "kind": "code", - "text": "`entryPointsStrategy`" - }, - { - "kind": "text", - "text": " but rather provides some flexibility as to how output files are generated.\n\nIt is also possible to further refine what members are exported to individual files with the [" - }, - { - "kind": "code", - "text": "`membersWithOwnFile`" - }, - { - "kind": "text", - "text": "](#memberswithownfile) option.\n\nThe following keys are available:\n\n- **\"members\":** generates an individual file for each exported module member. This is the standard behavior of the HTML theme and the default setting of the plugin.\n- **\"modules\"**: generates a single file for every Module or Namespace where all members are hoisted to a single module file. This creates a flat navigation structure and reduces the amount of files generated." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 27, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L27" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 83, - "name": "membersWithOwnFile", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option is useful when only specific types of members should be exported to a single file.\n\nIgnored when [" - }, - { - "kind": "code", - "text": "`outputFileStrategy`" - }, - { - "kind": "text", - "text": "](#outputfilestrategy) is equal to " - }, - { - "kind": "code", - "text": "`\"modules\"`" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n[\"Class\", \"Enum\", \"Interface\"]\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 45, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L45" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 84, - "name": "flattenOutputFiles", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default output files are generated in a directory structure that mirrors the project's module hierarchy including folders for member kinds eg " - }, - { - "kind": "code", - "text": "`classes`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`enums`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`functions`" - }, - { - "kind": "text", - "text": " etc." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 70, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L70" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 85, - "name": "fileExtension", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "Typically markdown files are recognised by the " - }, - { - "kind": "code", - "text": "`.md`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`.markdown`" - }, - { - "kind": "text", - "text": " file extensions." - }, - { - "kind": "code", - "text": "`.mdx`" - }, - { - "kind": "text", - "text": " maybe required for compatibility with certain markdown parsers." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n\".mdx\"\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 85, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L85" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 86, - "name": "entryFileName", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "The entry page is the root page of the documentation, equivalent to " - }, - { - "kind": "code", - "text": "`index.html`" - }, - { - "kind": "text", - "text": " for web pages.\n\n" - }, - { - "kind": "code", - "text": "`README`" - }, - { - "kind": "text", - "text": " is recognised when browsing folders on repos and Wikis and is the plugin default. " - }, - { - "kind": "code", - "text": "`index`" - }, - { - "kind": "text", - "text": " might be more suitable for static site generators.\n\nThe content of this file will be resolved in the following order:\n\n1. The value of the [" - }, - { - "kind": "code", - "text": "`entryModule`" - }, - { - "kind": "text", - "text": "](#entrymodule) option (if defined).\n2. The resolved Readme file (skipped if the [" - }, - { - "kind": "code", - "text": "`readme`" - }, - { - "kind": "text", - "text": "](https://typedoc.org/options/input/#readme) option is set to " - }, - { - "kind": "code", - "text": "`none`" - }, - { - "kind": "text", - "text": ").\n3. The documentation index page." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n\"index\"\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 116, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 87, - "name": "entryModule", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option can be used when the root page of the documentation should be a specific module (typically a module named " - }, - { - "kind": "code", - "text": "`index`" - }, - { - "kind": "text", - "text": ").\n\nThe module name should be specified (NOT the reference to the file name).\n\nPlease note a separate modules index page will not be generated, therefore would work better if navigation is present." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n\"index\"\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 135, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L135" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 88, - "name": "excludeScopesInPaths", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default directories are split by scopes when generating file paths.\n\nThis option will remove reference to " - }, - { - "kind": "code", - "text": "`@scope`" - }, - { - "kind": "text", - "text": " in the path when generating files and directories. It does not affect the name of the package or module in the output.\n\nThe following will be the directory structure for packages named " - }, - { - "kind": "code", - "text": "`@scope/package-1`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`@scope/package-2`" - }, - { - "kind": "text", - "text": ":\n\nIgnored if " - }, - { - "kind": "code", - "text": "`flattenOutputFiles`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 153, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L153" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 89, - "name": "mergeReadme", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default when a readme file is resolved, a separate readme page is created.\nThis option appends the index page to the readme so only a single root page is generated.\n\nYou can additionally configure the generated title with " - }, - { - "kind": "code", - "text": "`\"textContentMappings\": { \"title.indexPage\" : \"My API\"}`" - }, - { - "kind": "text", - "text": ".\nSee [" - }, - { - "kind": "code", - "text": "`--textContentMappings`" - }, - { - "kind": "text", - "text": "](/docs/options/utility-options#--textcontentmappings).\n\nThis option has no effect when [" - }, - { - "kind": "code", - "text": "`readme`" - }, - { - "kind": "text", - "text": "](https://typedoc.org/options/input/#readme) is set to " - }, - { - "kind": "code", - "text": "`\"none\"`" - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 172, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L172" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 90, - "name": "hidePageHeader", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 181, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L181" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 91, - "name": "hidePageTitle", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 190, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L190" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 92, - "name": "hideBreadcrumbs", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 199, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L199" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 93, - "name": "hideGroupHeadings", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default members are grouped by kind (eg Classes, Functions etc).\n\nThis creates a flat structure where all members are displayed at the same heading level." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 214, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L214" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 94, - "name": "useCodeBlocks", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option can be used to improve readability and aesthetics when defining signatures and declarations.\n\nPlease note that when this option is set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " it is not possible to link to other references.\n\nAs a work around the [" - }, - { - "kind": "code", - "text": "`@link`" - }, - { - "kind": "text", - "text": "](https://typedoc.org/tags/link/) tag can be be used to manually reference types." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 242, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L242" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 95, - "name": "expandObjects", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default objects inside declarations are collapsed to preserve space and improve readability.\n\nThis option should be set when a full object representation is preferred." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 257, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L257" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 96, - "name": "expandParameters", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default parameters in signature definitions only display the parameter name so the output is more concise.\n\nThis option should be set when a full type representation is preferred." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 272, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L272" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 97, - "name": "parametersFormat", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option specifies the output format for parameters and type parameters of functions and class methods:\n\n- **\"list\"**: parameters are output as bullet points in a linear list, suitable for more detailed comments.\n- **\"table\"**: parameters are output within a markdown table, condensed into a single paragraph.\n- **\"htmlTable\"**: parameters are output in an HTML table, enabling block elements to render in tabular format" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 289, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L289" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "propertiesFormat", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option specifies the output format for class and interface properties:\n\n- **\"list\"**: properties are output in linear blocks with headings, suitable for more detailed comments.\n- **\"table\"**: properties are output within a markdown table, condensed into a single paragraph.\n- **\"htmlTable\"**: properties are output in an HTML table, enabling block elements to render in tabular format." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 307, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L307" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 99, - "name": "enumMembersFormat", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option specifies the output format for enumeration members:\n\n- **\"list\"**: members are output in linear blocks with headings, suitable for more detailed comments.\n- **\"table\"**: members are output within a markdown table, condensed into a single paragraph.\n- **\"htmlTable\"**: members are output in an HTML table, enabling block elements to render in tabular format." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 325, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L325" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 100, - "name": "typeDeclarationFormat", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option specifies the output format for type declaration:\n\n- **\"list\"**: declarations are output in linear blocks with headings, suitable for more detailed comments.\n- **\"table\"**: declarations are output within a markdown table, condensed into a single paragraph.\n- **\"htmlTable\"**: declarations are output in an HTML table, enabling block elements to render in tabular format." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 343, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L343" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 101, - "name": "indexFormat", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option renders index items either as a simple unordered list or in a table.\n\nWhen table style is selected the following will be the behaviour:\n\n- For a **members index**, a description column will be added to the table with the first paragraph of the comment summary.\n- For a **packages index**, (when " - }, - { - "kind": "code", - "text": "`--entryPointStrategy`" - }, - { - "kind": "text", - "text": " equals " - }, - { - "kind": "code", - "text": "`packages`" - }, - { - "kind": "text", - "text": "), the package.json description will be displayed with an additional \"Version\" column (when " - }, - { - "kind": "code", - "text": "`--includeVersion`" - }, - { - "kind": "text", - "text": " equals true).\n- For a **documents index** a description column will be added to the table printing the " - }, - { - "kind": "code", - "text": "`description`" - }, - { - "kind": "text", - "text": " frontmatter if present." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 363, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L363" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 102, - "name": "tableColumnSettings", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default, all available data for symbols are displayed in table columns. For some reflections this can result in several columns.\n\nThis option allows you to control the visibility of columns, prioritizing readability over displaying complete data.\nIn addition you can control the alignment of the header text." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 380, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L380" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 103, - "name": "publicPath", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "If undefined all urls will be relative." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n\"http://abc.com\"\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 403, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L403" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 104, - "name": "sanitizeComments", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "*Please note this options does not affect the rendering of inline code or code blocks (using single/triple backticks).*\n\nBy default all comments written inside JsDoc comments will be passed to the output as written, and parsers will interpret un-escaped angle brackets as HTML/JSX tags..\n\nThis option will escape angle brackets " - }, - { - "kind": "code", - "text": "`<`" - }, - { - "kind": "text", - "text": " " - }, - { - "kind": "code", - "text": "`>`" - }, - { - "kind": "text", - "text": " and curly braces " - }, - { - "kind": "code", - "text": "`{`" - }, - { - "kind": "text", - "text": " " - }, - { - "kind": "code", - "text": "`}`" - }, - { - "kind": "text", - "text": " written inside JsDoc comments.\n\nThis option would typically be used when source code comes from an external library exposing the following potential issues:\n\n- Comments contain raw tags that should be interpreted as code examples.\n- Comments contain invalid syntax that (in the case of MDX) will cause breaking parsing errors.\n- Although most parsers use XSS filters, this option provides an additional layer of XSS security." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 426, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L426" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 105, - "name": "anchorPrefix", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option should be used when parsers require a custom anchor prefix." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n\"markdown-header\"\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 441, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L441" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 106, - "name": "useHTMLAnchors", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This option should be used if there are issues with anchoring to symbols within a page.\n\n- For markdown parsers that do not automatically assign header ids.\n- When cross referencing symbols that are referenced in a table row." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 457, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L457" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 107, - "name": "preserveAnchorCasing", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default references to symbol anchor links are lowercased.\n\nThis option can be used for engines that require the preservation of anchor link casing." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 472, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L472" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 108, - "name": "navigationModel", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "By default navigation is not written to file but can be consumed programmatically.\nThis is useful if you want to provide a custom sidebar/navigation implementation (if relevant to your environment).\n\nThe navigation model can be accessed by utilizing the " - }, - { - "kind": "code", - "text": "`postRenderAsyncJobs`" - }, - { - "kind": "text", - "text": " on the renderer.\n\nThe navigation is returned as " - }, - { - "kind": "code", - "text": "`JSON`" - }, - { - "kind": "text", - "text": " and can be mapped to a custom structure and written to a file.\n\n- " - }, - { - "kind": "code", - "text": "`navigationModel.excludeGroups`" - }, - { - "kind": "text", - "text": ": do not organise navigation by groups.\n- " - }, - { - "kind": "code", - "text": "`navigationModel.excludeCategories`" - }, - { - "kind": "text", - "text": ": do not organise navigation by categories.\n- " - }, - { - "kind": "code", - "text": "`navigationModel.excludeFolders`" - }, - { - "kind": "text", - "text": ": excludes unnecessary nesting with complex hierarchies.\n\n" - }, - { - "kind": "code", - "text": "```ts filename=\"custom-plugin.ts\"\n\nimport { MarkdownApplication } from 'typedoc-plugin-markdown';\n\nexport function load(app: MarkdownApplication) {\n app.renderer.postRenderAsyncJobs.push(async (renderer) => {\n // The navigation JSON structure is available on the navigation object.\n const navigation = renderer.navigation;\n\n // This can be parsed to something else or written straight to a file:\n fs.writeFileSync('navigation.json', JSON.stringify(navigation));\n });\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 510, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L510" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - }, - { - "id": 109, - "name": "textContentMappings", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "Defines placeholder text in main template that can be customized. Includes the main page header and breadcrumbs (if displayed),\npage titles and page footer.\n\nDefault values within curly braces {} indicates a placeholder of dynamic text.\n\n- The " - }, - { - "kind": "code", - "text": "`{projectName}`" - }, - { - "kind": "text", - "text": " placeholder writes project's name .\n- The " - }, - { - "kind": "code", - "text": "`{kind}`" - }, - { - "kind": "text", - "text": " writes the reflection kind of the page.\n- The " - }, - { - "kind": "code", - "text": "`{version}`" - }, - { - "kind": "text", - "text": " placeholder writes package version (if includeVersion is " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ").\n\nIf you are looking for general localization support please see [localization]()." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 535, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L535" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/declaration.d.ts", - "qualifiedName": "DeclarationOption" - }, - "name": "DeclarationOption", - "package": "typedoc" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Variables", - "children": [ - 82, - 83, - 84, - 85, - 86, - 87, - 88, - 89, - 90, - 91, - 92, - 93, - 94, - 95, - 96, - 97, - 98, - 99, - 100, - 101, - 102, - 103, - 104, - 105, - 106, - 107, - 108, - 109 - ] - } - ], - "categories": [ - { - "title": "Display Options", - "children": [ - 90, - 91, - 92, - 93, - 94, - 95, - 96, - 97, - 98, - 99, - 100, - 101, - 102 - ] - }, - { - "title": "File Options", - "children": [ - 82, - 83, - 84, - 85, - 86, - 87, - 88, - 89 - ] - }, - { - "title": "Utility Options", - "children": [ - 103, - 104, - 105, - 106, - 107, - 108, - 109 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/declarations.ts#L1" - } - ] - }, - { - "id": 110, - "name": "maps", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maps a given value to the option type." - } - ] - }, - "children": [ - { - "id": 111, - "name": "OutputFileStrategy", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The allowed values of the " - }, - { - "kind": "code", - "text": "`--outputFileStrategy`" - }, - { - "kind": "text", - "text": " option." - } - ] - }, - "children": [ - { - "id": 112, - "name": "Members", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 11, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L11" - } - ], - "type": { - "type": "literal", - "value": "members" - } - }, - { - "id": 113, - "name": "Modules", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 12, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L12" - } - ], - "type": { - "type": "literal", - "value": "modules" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 112, - 113 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 10, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L10" - } - ] - }, - { - "id": 114, - "name": "ReflectionFormat", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The allowed values for formatting reflections." - } - ] - }, - "children": [ - { - "id": 115, - "name": "List", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 19, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L19" - } - ], - "type": { - "type": "literal", - "value": "list" - } - }, - { - "id": 116, - "name": "Table", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 20, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L20" - } - ], - "type": { - "type": "literal", - "value": "table" - } - }, - { - "id": 117, - "name": "HtmlTable", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 21, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L21" - } - ], - "type": { - "type": "literal", - "value": "htmlTable" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 115, - 116, - 117 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 18, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L18" - } - ] - }, - { - "id": 118, - "name": "IndexFormat", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The allowed values for formatting indexes." - } - ] - }, - "children": [ - { - "id": 119, - "name": "List", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 28, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L28" - } - ], - "type": { - "type": "literal", - "value": "list" - } - }, - { - "id": 120, - "name": "Table", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 29, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L29" - } - ], - "type": { - "type": "literal", - "value": "table" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 119, - 120 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 27, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L27" - } - ] - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [ - 111, - 114, - 118 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/maps.ts#L1" - } - ] - }, - { - "id": 121, - "name": "types", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Describes the options declared by the plugin." - } - ] - }, - "children": [ - { - "id": 122, - "name": "PluginOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 123, - "name": "anchorPrefix", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom anchor prefix when anchoring to in-page symbols." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 14, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 124, - "name": "entryFileName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file name of the entry page." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 125, - "name": "entryModule", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of a module that should act as the root page for the documentation." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 24, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 126, - "name": "enumMembersFormat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the render style of enumeration members." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 29, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L29" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "table" - }, - { - "type": "literal", - "value": "list" - }, - { - "type": "literal", - "value": "htmlTable" - } - ] - } - }, - { - "id": 127, - "name": "excludeGroups", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "This option has been renamed hideGroupHeadings to better reflect its purpose." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 34, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L34" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 128, - "name": "excludeScopesInPaths", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exclude writing @ scope directories in paths." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 39, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L39" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 129, - "name": "expandObjects", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Expand objects inside declarations." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 44, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 130, - "name": "expandParameters", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Expand parameters in signature parentheses to display type information." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 49, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L49" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 131, - "name": "fileExtension", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the file extension for generated output files." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 54, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L54" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 132, - "name": "flattenOutputFiles", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Flatten output files to a single directory." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 59, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 133, - "name": "hideBreadcrumbs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Do not print breadcrumbs." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 64, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L64" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 134, - "name": "hideGroupHeadings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Excludes grouping by kind so all members are rendered and sorted at the same level." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 69, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L69" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 135, - "name": "hidePageHeader", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Do not print page header." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 74, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L74" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 136, - "name": "hidePageTitle", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Do not print page title." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 79, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 137, - "name": "indexFormat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the render format for index items." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 84, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L84" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "table" - }, - { - "type": "literal", - "value": "list" - } - ] - } - }, - { - "id": 138, - "name": "membersWithOwnFile", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines which members are exported to their own file when " - }, - { - "kind": "code", - "text": "`outputFileStrategy`" - }, - { - "kind": "text", - "text": " equals " - }, - { - "kind": "code", - "text": "`members`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 89, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L89" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "Enum" - }, - { - "type": "literal", - "value": "Variable" - }, - { - "type": "literal", - "value": "Function" - }, - { - "type": "literal", - "value": "Class" - }, - { - "type": "literal", - "value": "Interface" - }, - { - "type": "literal", - "value": "TypeAlias" - } - ] - } - } - }, - { - "id": 139, - "name": "mergeReadme", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Merges the resolved readme into the project index page." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 101, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L101" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 140, - "name": "navigationModel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configures how the navigation model will be generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 106, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L106" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 142, - "name": "excludeGroups", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 107, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L107" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 143, - "name": "excludeCategories", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 108, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L108" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 144, - "name": "excludeFolders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 109, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L109" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 142, - 143, - 144 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 106, - "character": 19, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L106" - } - ] - } - } - }, - { - "id": 145, - "name": "outputFileStrategy", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how output files are generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 115, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L115" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "members" - }, - { - "type": "literal", - "value": "modules" - } - ] - } - }, - { - "id": 146, - "name": "parametersFormat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the render style of parameter and type parameter groups." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 120, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L120" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "table" - }, - { - "type": "literal", - "value": "list" - }, - { - "type": "literal", - "value": "htmlTable" - } - ] - } - }, - { - "id": 147, - "name": "preserveAnchorCasing", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Preserve anchor casing when generating link to symbols." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L125" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 148, - "name": "propertiesFormat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the render style of property groups for interfaces and classes." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 130, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L130" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "table" - }, - { - "type": "literal", - "value": "list" - }, - { - "type": "literal", - "value": "htmlTable" - } - ] - } - }, - { - "id": 149, - "name": "publicPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the base path for all urls." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 135, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L135" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 150, - "name": "sanitizeComments", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sanitize HTML and JSX inside JsDoc comments." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 140, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L140" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 151, - "name": "tableColumnSettings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Control header alignment and column visibility in tables." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 145, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L145" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 153, - "name": "hideDefaults", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 146, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L146" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 154, - "name": "hideInherited", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 147, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L147" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 155, - "name": "hideModifiers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 148, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L148" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 156, - "name": "hideOverrides", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 149, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L149" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 157, - "name": "hideSources", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 150, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L150" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 158, - "name": "hideValues", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 151, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L151" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 159, - "name": "leftAlignHeaders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 152, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L152" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 153, - 154, - 155, - 156, - 157, - 158, - 159 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 145, - "character": 23, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L145" - } - ] - } - } - }, - { - "id": 160, - "name": "textContentMappings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Change specific text placeholders in the template." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 158, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L158" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 162, - "name": "header.title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 159, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L159" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 163, - "name": "header.docs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 160, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L160" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 164, - "name": "breadcrumbs.home", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 161, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L161" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 165, - "name": "title.indexPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 162, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 166, - "name": "title.memberPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 163, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L163" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 167, - "name": "footer.text", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 164, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L164" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 162, - 163, - 164, - 165, - 166, - 167 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 158, - "character": 23, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L158" - } - ] - } - } - }, - { - "id": 168, - "name": "typeDeclarationFormat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the render style for type declaration members." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 170, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L170" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "table" - }, - { - "type": "literal", - "value": "list" - }, - { - "type": "literal", - "value": "htmlTable" - } - ] - } - }, - { - "id": 169, - "name": "useCodeBlocks", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps signatures and declarations in code blocks." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 175, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L175" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 170, - "name": "useHTMLAnchors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add HTML named anchors to headings and table rows." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 180, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L180" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 123, - 124, - 125, - 126, - 127, - 128, - 129, - 130, - 131, - 132, - 133, - 134, - 135, - 136, - 137, - 138, - 139, - 140, - 145, - 146, - 147, - 148, - 149, - 150, - 151, - 160, - 168, - 169, - 170 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 10, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L10" - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 122 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/types.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Namespaces", - "children": [ - 71, - 81, - 110, - 121 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/options/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/options/index.ts#L1" - } - ] - }, - { - "id": 171, - "name": "internationalization", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exposes additional i18n keys and translations used by the theme." - } - ] - }, - "children": [ - { - "id": 172, - "name": "locales", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of plugin specific translations per locale." - } - ] - }, - "children": [ - { - "id": 173, - "name": "en", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts", - "line": 3, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L3" - } - ], - "type": { - "type": "reference", - "target": 180, - "name": "TranslatableStrings", - "package": "typedoc-plugin-markdown" - }, - "defaultValue": "..." - }, - { - "id": 174, - "name": "ko", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts", - "line": 3, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L3" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 180, - "name": "TranslatableStrings", - "package": "typedoc-plugin-markdown" - } - ], - "name": "Partial", - "package": "typescript" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Variables", - "children": [ - 173, - 174 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts#L1" - } - ] - }, - { - "id": 175, - "name": "translatable", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Translations methods." - } - ] - }, - "children": [ - { - "id": 176, - "name": "getTranslatable", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/translatable.ts", - "line": 14, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L14" - } - ], - "signatures": [ - { - "id": 177, - "name": "getTranslatable", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns subset of translatable strings for the plugin.\n\nThese will then be merged with the main set of TypeDoc string." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/translatable.ts", - "line": 14, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L14" - } - ], - "parameters": [ - { - "id": 178, - "name": "app", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/application.d.ts", - "qualifiedName": "Application" - }, - "name": "Application", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 176 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/translatable.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L1" - } - ] - }, - { - "id": 179, - "name": "types", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Internationalization types." - } - ] - }, - "children": [ - { - "id": 180, - "name": "TranslatableStrings", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The model of translatable strings specific to the Markdown theme." - } - ] - }, - "children": [ - { - "id": 181, - "name": "theme_default_value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 11, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 182, - "name": "theme_default_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 183, - "name": "theme_description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 184, - "name": "theme_event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 14, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 185, - "name": "theme_extends", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 15, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L15" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 186, - "name": "theme_extended_by", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 16, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 187, - "name": "theme_member", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 17, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L17" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 188, - "name": "theme_member_plural", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 18, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L18" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 189, - "name": "theme_modifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 190, - "name": "theme_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 20, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L20" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 191, - "name": "theme_packages", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 21, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 192, - "name": "theme_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 22, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L22" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 193, - "name": "theme_value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 23, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L23" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 194, - "name": "theme_version", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 24, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 181, - 182, - 183, - 184, - 185, - 186, - 187, - 188, - 189, - 190, - 191, - 192, - 193, - 194 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 10, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L10" - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 180 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Namespaces", - "children": [ - 172, - 175, - 179 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/internationalization/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/internationalization/index.ts#L1" - } - ] - }, - { - "id": 195, - "name": "theme", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This is the built-in Markdown theme." - } - ] - }, - "children": [ - { - "id": 196, - "name": "context", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Support and resources for the theme MarkdownThemeContext class." - } - ] - }, - "children": [ - { - "id": 197, - "name": "helpers", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`helpers`" - }, - { - "kind": "text", - "text": " namespace holds the helpers for the theme and are smaller utility functions that return snippets or text or other data transformations.\n\nPlease note that partials:\n\n- Take a " - }, - { - "kind": "code", - "text": "`model`" - }, - { - "kind": "text", - "text": " param (that references a specific TypeDoc model) and an " - }, - { - "kind": "code", - "text": "`options`" - }, - { - "kind": "text", - "text": " param if required.\n- Can reference other helpers but should not reference partials.\n- Can return strings or other models." - } - ] - }, - "children": [ - { - "id": 198, - "name": "getCommentParts", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts#L6" - } - ], - "signatures": [ - { - "id": 199, - "name": "getCommentParts", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts#L6" - } - ], - "parameters": [ - { - "id": 200, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 201, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/comments/comment.d.ts", - "qualifiedName": "CommentDisplayPart" - }, - "name": "CommentDisplayPart", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 202, - "name": "isFile", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "line": 64, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts#L64" - } - ], - "signatures": [ - { - "id": 203, - "name": "isFile", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "line": 64, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts#L64" - } - ], - "parameters": [ - { - "id": 204, - "name": "file", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 205, - "name": "getDeclarationType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts#L3" - } - ], - "signatures": [ - { - "id": 206, - "name": "getDeclarationType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts#L3" - } - ], - "parameters": [ - { - "id": 207, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "SomeType" - }, - "name": "SomeType", - "package": "typedoc" - } - ] - } - } - ] - }, - { - "id": 208, - "name": "getDescriptionForReflection", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts", - "line": 4, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts#L4" - } - ], - "signatures": [ - { - "id": 209, - "name": "getDescriptionForReflection", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts", - "line": 4, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts#L4" - } - ], - "parameters": [ - { - "id": 210, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 211, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - }, - { - "id": 212, - "name": "getFlattenedDeclarations", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts#L3" - } - ], - "signatures": [ - { - "id": 213, - "name": "getFlattenedDeclarations", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts#L3" - } - ], - "parameters": [ - { - "id": 214, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - }, - { - "id": 215, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 216, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 217, - "name": "includeSignatures", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "line": 5, - "character": 14, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts#L5" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 217 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "line": 5, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts#L5" - } - ] - } - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - } - ] - }, - { - "id": 218, - "name": "getGroupIndexList", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts#L6" - } - ], - "signatures": [ - { - "id": 219, - "name": "getGroupIndexList", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts#L6" - } - ], - "parameters": [ - { - "id": 220, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 221, - "name": "children", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/document.d.ts", - "qualifiedName": "DocumentReflection" - }, - "name": "DocumentReflection", - "package": "typedoc" - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 222, - "name": "getGroupIndexTable", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts#L10" - } - ], - "signatures": [ - { - "id": 223, - "name": "getGroupIndexTable", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts#L10" - } - ], - "parameters": [ - { - "id": 224, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 225, - "name": "children", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/document.d.ts", - "qualifiedName": "DocumentReflection" - }, - "name": "DocumentReflection", - "package": "typedoc" - } - } - ] - } - }, - { - "id": 226, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/kind.d.ts", - "qualifiedName": "ReflectionKind" - }, - "name": "ReflectionKind", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 227, - "name": "getGroupIndex", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts#L8" - } - ], - "signatures": [ - { - "id": 228, - "name": "getGroupIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts#L8" - } - ], - "parameters": [ - { - "id": 229, - "name": "group", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/ReflectionCategory.d.ts", - "qualifiedName": "ReflectionCategory" - }, - "name": "ReflectionCategory", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/ReflectionGroup.d.ts", - "qualifiedName": "ReflectionGroup" - }, - "name": "ReflectionGroup", - "package": "typedoc" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 230, - "name": "getHierarchyType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "line": 5, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts#L5" - } - ], - "signatures": [ - { - "id": 231, - "name": "getHierarchyType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "line": 5, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts#L5" - } - ], - "parameters": [ - { - "id": 232, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 233, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "SomeType" - }, - "name": "SomeType", - "package": "typedoc" - } - }, - { - "id": 234, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 235, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 236, - "name": "isTarget", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "line": 8, - "character": 14, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts#L8" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 236 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "line": 8, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts#L8" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 237, - "name": "getKeyword", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts#L3" - } - ], - "signatures": [ - { - "id": 238, - "name": "getKeyword", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts#L3" - } - ], - "parameters": [ - { - "id": 239, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/kind.d.ts", - "qualifiedName": "ReflectionKind" - }, - "name": "ReflectionKind", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 240, - "name": "getModifier", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts#L3" - } - ], - "signatures": [ - { - "id": 241, - "name": "getModifier", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts#L3" - } - ], - "parameters": [ - { - "id": 242, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "id": 243, - "name": "getParameterDefaultValue", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts#L3" - } - ], - "signatures": [ - { - "id": 244, - "name": "getParameterDefaultValue", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts#L3" - } - ], - "parameters": [ - { - "id": 245, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/parameter.d.ts", - "qualifiedName": "ParameterReflection" - }, - "name": "ParameterReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 246, - "name": "getProjectName", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts", - "line": 4, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts#L4" - } - ], - "signatures": [ - { - "id": 247, - "name": "getProjectName", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts", - "line": 4, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts#L4" - } - ], - "parameters": [ - { - "id": 248, - "name": "stringWithPlaceholders", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 249, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 250, - "name": "getPropertyDefaultValue", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts", - "line": 4, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts#L4" - } - ], - "signatures": [ - { - "id": 251, - "name": "getPropertyDefaultValue", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts", - "line": 4, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts#L4" - } - ], - "parameters": [ - { - "id": 252, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - }, - { - "id": 253, - "name": "getReflectionFlags", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts", - "line": 5, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts#L5" - } - ], - "signatures": [ - { - "id": 254, - "name": "getReflectionFlags", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts", - "line": 5, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts#L5" - } - ], - "parameters": [ - { - "id": 255, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 256, - "name": "reflection", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - ] - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ] - }, - { - "id": 257, - "name": "getReturnType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts", - "line": 5, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts#L5" - } - ], - "signatures": [ - { - "id": 258, - "name": "getReturnType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts", - "line": 5, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts#L5" - } - ], - "parameters": [ - { - "id": 259, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 260, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "SomeType" - }, - "name": "SomeType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 261, - "name": "isGroupKind", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts#L7" - } - ], - "signatures": [ - { - "id": 262, - "name": "isGroupKind", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts#L7" - } - ], - "parameters": [ - { - "id": 263, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 264, - "name": "useTableFormat", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts#L3" - } - ], - "signatures": [ - { - "id": 265, - "name": "useTableFormat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts#L3" - } - ], - "parameters": [ - { - "id": 266, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 267, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "parameters" - }, - { - "type": "literal", - "value": "properties" - }, - { - "type": "literal", - "value": "enums" - }, - { - "type": "literal", - "value": "typeDeclarations" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 198, - 202, - 205, - 208, - 212, - 218, - 222, - 227, - 230, - 237, - 240, - 243, - 246, - 250, - 253, - 257, - 261, - 264 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/helpers/index.ts#L1" - } - ] - }, - { - "id": 268, - "name": "partials", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`partials`" - }, - { - "kind": "text", - "text": " namespace holds the partials for the theme and are used by templates to map speficic models to page output.\n\nPlease note that partials::\n\n- Take a " - }, - { - "kind": "code", - "text": "`model`" - }, - { - "kind": "text", - "text": " param (that references a specific TypeDoc model) and an " - }, - { - "kind": "code", - "text": "`options`" - }, - { - "kind": "text", - "text": " param if required.\n- Can call other partials and helpers.\n- Must return a string.\n\nPartials are categorised by their use:\n\n- Page Partials: Partials that render core page elements such as header and breadcrumbs.\n- Container Partials: Partials that are used to render reflection groups and categories.\n- Member Partials: Partials that render specific parts of reflections.\n- Comment Partials: Partials that render comments.\n- Type Partials: Partials that render specific TypeDoc model types." - } - ] - }, - "children": [ - { - "id": 269, - "name": "comment", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L9" - } - ], - "signatures": [ - { - "id": 270, - "name": "comment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L9" - } - ], - "parameters": [ - { - "id": 271, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 272, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/comments/comment.d.ts", - "qualifiedName": "Comment" - }, - "name": "Comment", - "package": "typedoc" - } - }, - { - "id": 273, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 275, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "line": 13, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 276, - "name": "showSummary", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "line": 14, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 277, - "name": "showTags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "line": 15, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L15" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 278, - "name": "isTableColumn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "line": 16, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 275, - 276, - 277, - 278 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "line": 12, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts#L12" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 279, - "name": "commentParts", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts#L9" - } - ], - "signatures": [ - { - "id": 280, - "name": "commentParts", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts#L9" - } - ], - "parameters": [ - { - "id": 281, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 282, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/comments/comment.d.ts", - "qualifiedName": "CommentDisplayPart" - }, - "name": "CommentDisplayPart", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 283, - "name": "isFile", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "line": 67, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts#L67" - } - ], - "signatures": [ - { - "id": 284, - "name": "isFile", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "line": 67, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts#L67" - } - ], - "parameters": [ - { - "id": 285, - "name": "file", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 286, - "name": "body", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts#L11" - } - ], - "signatures": [ - { - "id": 287, - "name": "body", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts#L11" - } - ], - "parameters": [ - { - "id": 288, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 289, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/container.d.ts", - "qualifiedName": "ContainerReflection" - }, - "name": "ContainerReflection", - "package": "typedoc" - } - }, - { - "id": 290, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 291, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 292, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "line": 14, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 292 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "line": 14, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts#L14" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 293, - "name": "categories", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts#L10" - } - ], - "signatures": [ - { - "id": 294, - "name": "categories", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a collection of reflection categories." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts#L10" - } - ], - "parameters": [ - { - "id": 295, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 296, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/ReflectionCategory.d.ts", - "qualifiedName": "ReflectionCategory" - }, - "name": "ReflectionCategory", - "package": "typedoc" - } - } - }, - { - "id": 297, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 298, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 299, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "line": 13, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 299 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "line": 13, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 300, - "name": "groups", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "line": 14, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts#L14" - } - ], - "signatures": [ - { - "id": 301, - "name": "groups", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a collection of reflection groups." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "line": 14, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts#L14" - } - ], - "parameters": [ - { - "id": 302, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 303, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/ReflectionGroup.d.ts", - "qualifiedName": "ReflectionGroup" - }, - "name": "ReflectionGroup", - "package": "typedoc" - } - } - }, - { - "id": 304, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 305, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 306, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "line": 17, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts#L17" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 306 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "line": 17, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts#L17" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 307, - "name": "members", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts#L10" - } - ], - "signatures": [ - { - "id": 308, - "name": "members", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a collection of members." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts#L10" - } - ], - "parameters": [ - { - "id": 309, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 310, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - }, - { - "id": 311, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 312, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 313, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "line": 13, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 313 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "line": 13, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 314, - "name": "accessor", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts#L10" - } - ], - "signatures": [ - { - "id": 315, - "name": "accessor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders an accessor member." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts#L10" - } - ], - "parameters": [ - { - "id": 316, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 317, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "id": 318, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 320, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "line": 13, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 320 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "line": 13, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 321, - "name": "constructor", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts#L11" - } - ], - "signatures": [ - { - "id": 322, - "name": "constructor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders an constructor member." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts#L11" - } - ], - "parameters": [ - { - "id": 323, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 324, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "id": 325, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 326, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 327, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "line": 14, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 327 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "line": 14, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts#L14" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 328, - "name": "memberContainer", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts#L8" - } - ], - "signatures": [ - { - "id": 329, - "name": "memberContainer", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts#L8" - } - ], - "parameters": [ - { - "id": 330, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 331, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "id": 332, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 333, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 334, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "line": 11, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 335, - "name": "nested", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "line": 11, - "character": 35, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 334, - 335 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "line": 11, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts#L11" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 336, - "name": "declaration", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "line": 16, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts#L16" - } - ], - "signatures": [ - { - "id": 337, - "name": "declaration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a standard declaration member." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "line": 16, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts#L16" - } - ], - "parameters": [ - { - "id": 338, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 339, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "id": 340, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 341, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 342, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "line": 20, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts#L20" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 343, - "name": "nested", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "line": 21, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 342, - 343 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "line": 19, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts#L19" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 344, - "name": "declarationTitle", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts#L11" - } - ], - "signatures": [ - { - "id": 345, - "name": "declarationTitle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comments for declaration" - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts#L11" - } - ], - "parameters": [ - { - "id": 346, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 347, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 348, - "name": "documents", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "line": 13, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts#L13" - } - ], - "signatures": [ - { - "id": 349, - "name": "documents", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "line": 13, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts#L13" - } - ], - "parameters": [ - { - "id": 350, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 351, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/container.d.ts", - "qualifiedName": "ContainerReflection" - }, - "name": "ContainerReflection", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - ] - } - }, - { - "id": 352, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 353, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 354, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "line": 16, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 354 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "line": 16, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts#L16" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 355, - "name": "enumMembersTable", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts#L11" - } - ], - "signatures": [ - { - "id": 356, - "name": "enumMembersTable", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders enum members as a table." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts#L11" - } - ], - "parameters": [ - { - "id": 357, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 358, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 359, - "name": "hierarchy", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts#L8" - } - ], - "signatures": [ - { - "id": 360, - "name": "hierarchy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts#L8" - } - ], - "parameters": [ - { - "id": 361, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 362, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationHierarchy" - }, - "name": "DeclarationHierarchy", - "package": "typedoc" - } - }, - { - "id": 363, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 364, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 365, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "line": 11, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 365 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "line": 11, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts#L11" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 366, - "name": "indexSignature", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts#L10" - } - ], - "signatures": [ - { - "id": 367, - "name": "indexSignature", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders an index signature block" - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts#L10" - } - ], - "parameters": [ - { - "id": 368, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 369, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 370, - "name": "inheritance", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts#L10" - } - ], - "signatures": [ - { - "id": 371, - "name": "inheritance", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders an inheritance section." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts#L10" - } - ], - "parameters": [ - { - "id": 372, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 373, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - ] - } - }, - { - "id": 374, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 376, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "line": 13, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 376 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "line": 13, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 377, - "name": "memberTitle", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts#L11" - } - ], - "signatures": [ - { - "id": 378, - "name": "memberTitle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders the main member title." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts#L11" - } - ], - "parameters": [ - { - "id": 379, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 380, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 381, - "name": "memberWithGroups", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts#L10" - } - ], - "signatures": [ - { - "id": 382, - "name": "memberWithGroups", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a top-level member that contains group and child members such as Classes, Interfaces and Enums." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts#L10" - } - ], - "parameters": [ - { - "id": 383, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 384, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "id": 385, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 387, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "line": 13, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 387 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "line": 13, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 388, - "name": "parametersList", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts#L9" - } - ], - "signatures": [ - { - "id": 389, - "name": "parametersList", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts#L9" - } - ], - "parameters": [ - { - "id": 390, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 391, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/parameter.d.ts", - "qualifiedName": "ParameterReflection" - }, - "name": "ParameterReflection", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 392, - "name": "parametersTable", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts#L9" - } - ], - "signatures": [ - { - "id": 393, - "name": "parametersTable", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts#L9" - } - ], - "parameters": [ - { - "id": 394, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 395, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/parameter.d.ts", - "qualifiedName": "ParameterReflection" - }, - "name": "ParameterReflection", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 396, - "name": "propertiesTable", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "line": 15, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts#L15" - } - ], - "signatures": [ - { - "id": 397, - "name": "propertiesTable", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a collection of properties in a table.\n\nThere is no association list partial for properties as these are handled as a standard list of members." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "line": 15, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts#L15" - } - ], - "parameters": [ - { - "id": 398, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 399, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - }, - { - "id": 400, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 401, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 402, - "name": "isEventProps", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "line": 18, - "character": 14, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts#L18" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 402 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "line": 18, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts#L18" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 403, - "name": "referenceMember", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts#L10" - } - ], - "signatures": [ - { - "id": 404, - "name": "referenceMember", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders an reference member." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts#L10" - } - ], - "parameters": [ - { - "id": 405, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 406, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/reference.d.ts", - "qualifiedName": "ReferenceReflection" - }, - "name": "ReferenceReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 407, - "name": "reflectionIndex", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "line": 13, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts#L13" - } - ], - "signatures": [ - { - "id": 408, - "name": "reflectionIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "line": 13, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts#L13" - } - ], - "parameters": [ - { - "id": 409, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 410, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - ] - } - }, - { - "id": 411, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 412, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 413, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "line": 16, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 413 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "line": 16, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts#L16" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 414, - "name": "signature", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L10" - } - ], - "signatures": [ - { - "id": 415, - "name": "signature", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a signature member." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L10" - } - ], - "parameters": [ - { - "id": 416, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 417, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - }, - { - "id": 418, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 419, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 420, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "line": 14, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 421, - "name": "nested", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "line": 15, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L15" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 422, - "name": "accessor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "line": 16, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 423, - "name": "multipleSignatures", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "line": 17, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L17" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 420, - 421, - 422, - 423 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "line": 13, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 424, - "name": "signatureParameters", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts#L8" - } - ], - "signatures": [ - { - "id": 425, - "name": "signatureParameters", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts#L8" - } - ], - "parameters": [ - { - "id": 426, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 427, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/parameter.d.ts", - "qualifiedName": "ParameterReflection" - }, - "name": "ParameterReflection", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 428, - "name": "signatureReturns", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "line": 13, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts#L13" - } - ], - "signatures": [ - { - "id": 429, - "name": "signatureReturns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "line": 13, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts#L13" - } - ], - "parameters": [ - { - "id": 430, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 431, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - }, - { - "id": 432, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 433, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 434, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "line": 16, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 434 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "line": 16, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts#L16" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 435, - "name": "signatureTitle", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts#L9" - } - ], - "signatures": [ - { - "id": 436, - "name": "signatureTitle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts#L9" - } - ], - "parameters": [ - { - "id": 437, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 438, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - }, - { - "id": 439, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 440, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 441, - "name": "accessor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "line": 13, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "includeType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "line": 14, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 441, - 442 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "line": 12, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts#L12" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 443, - "name": "signatures", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts#L11" - } - ], - "signatures": [ - { - "id": 444, - "name": "signatures", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a signature collection." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts#L11" - } - ], - "parameters": [ - { - "id": 445, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 446, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "id": 447, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 448, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 449, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "line": 15, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts#L15" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 450, - "name": "nested", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "line": 16, - "character": 4, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 449, - 450 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "line": 14, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts#L14" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 451, - "name": "sources", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts#L9" - } - ], - "signatures": [ - { - "id": 452, - "name": "sources", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts#L9" - } - ], - "parameters": [ - { - "id": 453, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 454, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - ] - } - }, - { - "id": 455, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 456, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 457, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "line": 12, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 457 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "line": 12, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts#L12" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 458, - "name": "member", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts#L11" - } - ], - "signatures": [ - { - "id": 459, - "name": "member", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "line": 11, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts#L11" - } - ], - "parameters": [ - { - "id": 460, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 461, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - }, - { - "id": 462, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 463, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 464, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "line": 14, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 465, - "name": "nested", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "line": 14, - "character": 35, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 464, - 465 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "line": 14, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts#L14" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 466, - "name": "typeAndParent", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts#L8" - } - ], - "signatures": [ - { - "id": 467, - "name": "typeAndParent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts#L8" - } - ], - "parameters": [ - { - "id": 468, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 469, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "ReferenceType" - }, - "name": "ReferenceType", - "package": "typedoc" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "ArrayType" - }, - "name": "ArrayType", - "package": "typedoc" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 470, - "name": "typeArguments", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts#L7" - } - ], - "signatures": [ - { - "id": 471, - "name": "typeArguments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts#L7" - } - ], - "parameters": [ - { - "id": 472, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 473, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "SomeType" - }, - "name": "SomeType", - "package": "typedoc" - } - } - }, - { - "id": 474, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 475, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 476, - "name": "foreCollpase", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "line": 10, - "character": 14, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts#L10" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 476 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "line": 10, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts#L10" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 477, - "name": "typeDeclaration", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts#L7" - } - ], - "signatures": [ - { - "id": 478, - "name": "typeDeclaration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts#L7" - } - ], - "parameters": [ - { - "id": 479, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 480, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - }, - { - "id": 481, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 482, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 483, - "name": "headingLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "line": 10, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts#L10" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 483 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "line": 10, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts#L10" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 484, - "name": "typeDeclarationList", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts#L7" - } - ], - "signatures": [ - { - "id": 485, - "name": "typeDeclarationList", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts#L7" - } - ], - "parameters": [ - { - "id": 486, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 487, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - }, - { - "id": 488, - "name": "headingLevel", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 489, - "name": "typeDeclarationTable", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts#L9" - } - ], - "signatures": [ - { - "id": 490, - "name": "typeDeclarationTable", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts#L9" - } - ], - "parameters": [ - { - "id": 491, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 492, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 493, - "name": "typeParametersList", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts#L8" - } - ], - "signatures": [ - { - "id": 494, - "name": "typeParametersList", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts#L8" - } - ], - "parameters": [ - { - "id": 495, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 496, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/type-parameter.d.ts", - "qualifiedName": "TypeParameterReflection" - }, - "name": "TypeParameterReflection", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 497, - "name": "typeParametersTable", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts#L8" - } - ], - "signatures": [ - { - "id": 498, - "name": "typeParametersTable", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts#L8" - } - ], - "parameters": [ - { - "id": 499, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 500, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/type-parameter.d.ts", - "qualifiedName": "TypeParameterReflection" - }, - "name": "TypeParameterReflection", - "package": "typedoc" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 501, - "name": "breadcrumbs", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts#L9" - } - ], - "signatures": [ - { - "id": 502, - "name": "breadcrumbs", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts#L9" - } - ], - "parameters": [ - { - "id": 503, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 504, - "name": "footer", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts#L6" - } - ], - "signatures": [ - { - "id": 505, - "name": "footer", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts#L6" - } - ], - "parameters": [ - { - "id": 506, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 507, - "name": "header", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts", - "line": 15, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts#L15" - } - ], - "signatures": [ - { - "id": 508, - "name": "header", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts", - "line": 15, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts#L15" - } - ], - "parameters": [ - { - "id": 509, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 510, - "name": "packagesIndex", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts#L10" - } - ], - "signatures": [ - { - "id": 511, - "name": "packagesIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts", - "line": 10, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts#L10" - } - ], - "parameters": [ - { - "id": 512, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 513, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 514, - "name": "pageTitle", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts#L7" - } - ], - "signatures": [ - { - "id": 515, - "name": "pageTitle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts#L7" - } - ], - "parameters": [ - { - "id": 516, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 517, - "name": "arrayType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts#L7" - } - ], - "signatures": [ - { - "id": 518, - "name": "arrayType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts#L7" - } - ], - "parameters": [ - { - "id": 519, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 520, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "ArrayType" - }, - "name": "ArrayType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 521, - "name": "conditionalType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts#L8" - } - ], - "signatures": [ - { - "id": 522, - "name": "conditionalType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts#L8" - } - ], - "parameters": [ - { - "id": 523, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 524, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "ConditionalType" - }, - "name": "ConditionalType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 525, - "name": "indexAccessType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts#L7" - } - ], - "signatures": [ - { - "id": 526, - "name": "indexAccessType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts#L7" - } - ], - "parameters": [ - { - "id": 527, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 528, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "IndexedAccessType" - }, - "name": "IndexedAccessType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 529, - "name": "inferredType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts#L8" - } - ], - "signatures": [ - { - "id": 530, - "name": "inferredType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts#L8" - } - ], - "parameters": [ - { - "id": 531, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 532, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "InferredType" - }, - "name": "InferredType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 533, - "name": "intersectionType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts#L7" - } - ], - "signatures": [ - { - "id": 534, - "name": "intersectionType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts#L7" - } - ], - "parameters": [ - { - "id": 535, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 536, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "IntersectionType" - }, - "name": "IntersectionType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 537, - "name": "intrinsicType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts#L8" - } - ], - "signatures": [ - { - "id": 538, - "name": "intrinsicType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts#L8" - } - ], - "parameters": [ - { - "id": 539, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 540, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "IntrinsicType" - }, - "name": "IntrinsicType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 541, - "name": "literalType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts#L7" - } - ], - "signatures": [ - { - "id": 542, - "name": "literalType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts#L7" - } - ], - "parameters": [ - { - "id": 543, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 544, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "LiteralType" - }, - "name": "LiteralType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 545, - "name": "namedTupleType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts#L7" - } - ], - "signatures": [ - { - "id": 546, - "name": "namedTupleType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts#L7" - } - ], - "parameters": [ - { - "id": 547, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 548, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "NamedTupleMember" - }, - "name": "NamedTupleMember", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 549, - "name": "queryType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts#L8" - } - ], - "signatures": [ - { - "id": 550, - "name": "queryType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts#L8" - } - ], - "parameters": [ - { - "id": 551, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 552, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "QueryType" - }, - "name": "QueryType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 553, - "name": "referenceType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts#L8" - } - ], - "signatures": [ - { - "id": 554, - "name": "referenceType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts#L8" - } - ], - "parameters": [ - { - "id": 555, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 556, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "ReferenceType" - }, - "name": "ReferenceType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 557, - "name": "declarationType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts#L8" - } - ], - "signatures": [ - { - "id": 558, - "name": "declarationType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts#L8" - } - ], - "parameters": [ - { - "id": 559, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 560, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 561, - "name": "functionType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts#L8" - } - ], - "signatures": [ - { - "id": 562, - "name": "functionType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts#L8" - } - ], - "parameters": [ - { - "id": 563, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 564, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/signature.d.ts", - "qualifiedName": "SignatureReflection" - }, - "name": "SignatureReflection", - "package": "typedoc" - } - } - }, - { - "id": 565, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 566, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 567, - "name": "forceParameterType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "line": 11, - "character": 14, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 567 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "line": 11, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts#L11" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 568, - "name": "reflectionType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts#L8" - } - ], - "signatures": [ - { - "id": 569, - "name": "reflectionType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts#L8" - } - ], - "parameters": [ - { - "id": 570, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 571, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "ReflectionType" - }, - "name": "ReflectionType", - "package": "typedoc" - } - }, - { - "id": 572, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 573, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 574, - "name": "foreCollpase", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "line": 11, - "character": 14, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 574 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "line": 11, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts#L11" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 575, - "name": "someType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts", - "line": 26, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts#L26" - } - ], - "signatures": [ - { - "id": 576, - "name": "someType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes a generic Type and returns the appropriate partial for it." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts", - "line": 26, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts#L26" - } - ], - "parameters": [ - { - "id": 577, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 578, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "SomeType" - }, - "name": "SomeType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 579, - "name": "tupleType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts#L7" - } - ], - "signatures": [ - { - "id": 580, - "name": "tupleType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts#L7" - } - ], - "parameters": [ - { - "id": 581, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 582, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "TupleType" - }, - "name": "TupleType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 583, - "name": "typeOperatorType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts#L7" - } - ], - "signatures": [ - { - "id": 584, - "name": "typeOperatorType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts#L7" - } - ], - "parameters": [ - { - "id": 585, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 586, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "TypeOperatorType" - }, - "name": "TypeOperatorType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 587, - "name": "unionType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts#L7" - } - ], - "signatures": [ - { - "id": 588, - "name": "unionType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts#L7" - } - ], - "parameters": [ - { - "id": 589, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 590, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "UnionType" - }, - "name": "UnionType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 591, - "name": "unknownType", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts#L8" - } - ], - "signatures": [ - { - "id": 592, - "name": "unknownType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts#L8" - } - ], - "parameters": [ - { - "id": 593, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 594, - "name": "model", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/types.d.ts", - "qualifiedName": "UnknownType" - }, - "name": "UnknownType", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 269, - 279, - 283, - 286, - 293, - 300, - 307, - 314, - 321, - 328, - 336, - 344, - 348, - 355, - 359, - 366, - 370, - 377, - 381, - 388, - 392, - 396, - 403, - 407, - 414, - 424, - 428, - 435, - 443, - 451, - 458, - 466, - 470, - 477, - 484, - 489, - 493, - 497, - 501, - 504, - 507, - 510, - 514, - 517, - 521, - 525, - 529, - 533, - 537, - 541, - 545, - 549, - 553, - 557, - 561, - 568, - 575, - 579, - 583, - 587, - 591 - ] - } - ], - "categories": [ - { - "title": "Page Partials", - "children": [ - 501, - 504, - 507, - 510, - 514 - ] - }, - { - "title": "Container Partials", - "children": [ - 286, - 293, - 300, - 307 - ] - }, - { - "title": "Member Partials", - "children": [ - 314, - 321, - 328, - 336, - 344, - 348, - 355, - 359, - 366, - 370, - 377, - 381, - 388, - 392, - 396, - 403, - 407, - 414, - 424, - 428, - 435, - 443, - 451, - 458, - 466, - 470, - 477, - 484, - 489, - 493, - 497 - ] - }, - { - "title": "Comment Partials", - "children": [ - 269, - 279 - ] - }, - { - "title": "Type Partials", - "children": [ - 517, - 521, - 525, - 529, - 533, - 537, - 541, - 545, - 549, - 553, - 557, - 561, - 568, - 575, - 579, - 583, - 587, - 591 - ] - }, - { - "title": "Other", - "children": [ - 283 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/partials/index.ts#L1" - } - ] - }, - { - "id": 595, - "name": "templates", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Then " - }, - { - "kind": "code", - "text": "`templates`" - }, - { - "kind": "text", - "text": " namespace holds the main templates for the theme and are mapped to single pages and configured in the MarkdownTheme.\n\nAll templates return a string that is passed back to the renderer. Internally templates call partials and helpers." - } - ] - }, - "children": [ - { - "id": 596, - "name": "document", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts#L8" - } - ], - "signatures": [ - { - "id": 597, - "name": "document", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Template that maps to a project document." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts#L8" - } - ], - "parameters": [ - { - "id": 598, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 599, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/document.d.ts", - "qualifiedName": "DocumentReflection" - }, - "name": "DocumentReflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 600, - "name": "project", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts", - "line": 14, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts#L14" - } - ], - "signatures": [ - { - "id": 601, - "name": "project", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Template that maps to the root project reflection. This will be the index page / documentation root page." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts", - "line": 14, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts#L14" - } - ], - "parameters": [ - { - "id": 602, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 603, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 604, - "name": "readme", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts#L8" - } - ], - "signatures": [ - { - "id": 605, - "name": "readme", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Template that specifically maps to the resolved readme file. This template is not used when 'readme' is set to 'none'." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts", - "line": 8, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts#L8" - } - ], - "parameters": [ - { - "id": 606, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 607, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 608, - "name": "reflection", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts#L9" - } - ], - "signatures": [ - { - "id": 609, - "name": "reflection", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Template that maps to individual reflection models." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts", - "line": 9, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts#L9" - } - ], - "parameters": [ - { - "id": 610, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 611, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 596, - 600, - 604, - 608 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/templates/index.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Namespaces", - "children": [ - 197, - 268, - 595 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/index.ts#L1" - } - ] - }, - { - "id": 612, - "name": "core", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Support for the MarkdownTheme core class building URLs and navigation." - } - ] - }, - "children": [ - { - "id": 613, - "name": "NavigationBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 614, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "line": 25, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L25" - } - ], - "signatures": [ - { - "id": 615, - "name": "new NavigationBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "line": 25, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L25" - } - ], - "parameters": [ - { - "id": 616, - "name": "theme", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 660, - "name": "MarkdownTheme", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 617, - "name": "project", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "reference", - "target": 613, - "name": "NavigationBuilder", - "package": "typedoc-plugin-markdown" - } - } - ] - }, - { - "id": 618, - "name": "theme", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "line": 26, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L26" - } - ], - "type": { - "type": "reference", - "target": 660, - "name": "MarkdownTheme", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 619, - "name": "project", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "line": 27, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L27" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - }, - { - "id": 620, - "name": "getNavigation", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "line": 40, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L40" - } - ], - "signatures": [ - { - "id": 621, - "name": "getNavigation", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "line": 40, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L40" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 705, - "name": "NavigationItem", - "package": "typedoc-plugin-markdown" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 614 - ] - }, - { - "title": "Methods", - "children": [ - 620 - ] - }, - { - "title": "Properties", - "children": [ - 618, - 619 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "line": 18, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L18" - } - ] - }, - { - "id": 622, - "name": "UrlBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Map the models of the given project to the desired output files.\nBased on TypeDoc DefaultTheme.getUrls()" - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "project", - "content": [ - { - "kind": "text", - "text": "The project whose urls should be generated." - } - ] - } - ] - }, - "children": [ - { - "id": 623, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 40, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L40" - } - ], - "signatures": [ - { - "id": 624, - "name": "new UrlBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 40, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L40" - } - ], - "parameters": [ - { - "id": 625, - "name": "theme", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 660, - "name": "MarkdownTheme", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 626, - "name": "project", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "reference", - "target": 622, - "name": "UrlBuilder", - "package": "typedoc-plugin-markdown" - } - } - ] - }, - { - "id": 627, - "name": "theme", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 41, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L41" - } - ], - "type": { - "type": "reference", - "target": 660, - "name": "MarkdownTheme", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 628, - "name": "project", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 42, - "character": 11, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L42" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - }, - { - "id": 629, - "name": "getUrls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L65" - } - ], - "signatures": [ - { - "id": 630, - "name": "getUrls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L65" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 697, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "UrlMapping", - "package": "typedoc-plugin-markdown" - } - } - } - ] - }, - { - "id": 631, - "name": "getFlattenedUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 401, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L401" - } - ], - "signatures": [ - { - "id": 632, - "name": "getFlattenedUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 401, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L401" - } - ], - "parameters": [ - { - "id": 633, - "name": "reflection", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 623 - ] - }, - { - "title": "Methods", - "children": [ - 629, - 631 - ] - }, - { - "title": "Properties", - "children": [ - 627, - 628 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "line": 29, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L29" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [ - 613, - 622 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/core/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/core/index.ts#L1" - } - ] - }, - { - "id": 634, - "name": "MarkdownThemeContext", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The theme context class that is provided as context on the rendering of every page." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "It is heavily influenced by the equivalent [DefaultThemeRenderContext](https://typedoc.org/api/classes/DefaultThemeRenderContext.html) from the default theme.\n\nThis class can be used to customize the theme output by extending the class and overriding the templates, partials and helpers." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyMarkdownTheme extends MarkdownTheme {\n getRenderContext(page) {\n return new MyMarkdownThemeContext(this, page, this.application.options);\n }\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 635, - "name": "internationalization", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 50, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L50" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/internationalization/internationalization.d.ts", - "qualifiedName": "Internationalization" - }, - "name": "Internationalization", - "package": "typedoc" - } - }, - { - "id": 636, - "name": "i18n", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 51, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L51" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/internationalization/internationalization.d.ts", - "qualifiedName": "TranslationProxy" - }, - "name": "TranslationProxy", - "package": "typedoc" - } - }, - { - "id": 637, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 56, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L56" - } - ], - "signatures": [ - { - "id": 638, - "name": "new MarkdownThemeContext", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 56, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L56" - } - ], - "parameters": [ - { - "id": 639, - "name": "theme", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The theme instance." - } - ] - }, - "type": { - "type": "reference", - "target": 660, - "name": "MarkdownTheme", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 640, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current page event." - } - ] - }, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 641, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The options provided to the application." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/options.d.ts", - "qualifiedName": "Options" - }, - "name": "Options", - "package": "typedoc" - } - } - ], - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - } - ] - }, - { - "id": 642, - "name": "page", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current page event." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 64, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L64" - } - ], - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 643, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The options provided to the application." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 68, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L68" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/options.d.ts", - "qualifiedName": "Options" - }, - "name": "Options", - "package": "typedoc" - } - }, - { - "id": 644, - "name": "templates", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "templates", - "target": 644 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 87, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L87" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 645, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/resources.ts", - "line": 40, - "character": 9, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/resources.ts#L40" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 646, - "name": "partials", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "partials", - "target": 646 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 94, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L94" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 647, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/resources.ts", - "line": 69, - "character": 9, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/resources.ts#L69" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 648, - "name": "helpers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "helpers", - "target": 648 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 101, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L101" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/context/resources.ts", - "line": 560, - "character": 9, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/context/resources.ts#L560" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 650, - "name": "getPackageMetaData", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 108, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L108" - } - ], - "signatures": [ - { - "id": 651, - "name": "getPackageMetaData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the package meta data for a given package name when entrypointStrategy is set to " - }, - { - "kind": "code", - "text": "`packages`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 108, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L108" - } - ], - "parameters": [ - { - "id": 652, - "name": "packageName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The package name as per " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " field from " - }, - { - "kind": "code", - "text": "`package.json`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 694, - "name": "PackageMetaData", - "package": "typedoc-plugin-markdown" - } - } - ] - }, - { - "id": 653, - "name": "getRelativeUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 120, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L120" - } - ], - "signatures": [ - { - "id": 654, - "name": "getRelativeUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the relative URL (from the current page context url).\n\nIf public path is set, it will be used as the base URL." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 120, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L120" - } - ], - "parameters": [ - { - "id": 655, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to make relative." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 656, - "name": "ignorePublicPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to ignore the public path." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 657, - "name": "hook", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 150, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L150" - } - ], - "signatures": [ - { - "id": 658, - "name": "hook", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Hook into the TypeDoc rendering system." - } - ], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 150, - "character": 9, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L150" - } - ], - "parameters": [ - { - "id": 659, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 42, - "name": "MarkdownRendererHooks", - "package": "typedoc-plugin-markdown" - } - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 637 - ] - }, - { - "title": "Methods", - "description": [ - { - "kind": "text", - "text": "\nGeneral context aware helper methods not bound to any specific models that can be used by the theme resources." - } - ], - "children": [ - 650, - 653, - 657 - ] - }, - { - "title": "Properties", - "description": [ - { - "kind": "text", - "text": "\nProperties are passed into the constructor and are used to provide context to the theme." - } - ], - "children": [ - 635, - 636, - 642, - 643 - ] - }, - { - "title": "Resources", - "description": [ - { - "kind": "text", - "text": "\nTheme resources are the main building blocks for the theme context. They are split into three namespaces: " - }, - { - "kind": "code", - "text": "`templates`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`partials`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`helpers`" - }, - { - "kind": "text", - "text": "." - } - ], - "children": [ - 644, - 646, - 648 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "line": 49, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L49" - } - ] - }, - { - "id": 660, - "name": "MarkdownTheme", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The main theme class for the plugin." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc's base Theme class.\n\nYou would typically only be interested in overriding the the theme's render context instance.\n\nThe API follows the implementation of [TypeDoc's custom theming](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md) with some minor adjustments." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nexport function load(app) {\n app.renderer.defineTheme('customTheme', MyMarkdownTheme);\n}\n\nclass MyMarkdownTheme extends MarkdownTheme {\n ...\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 661, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/typedoc/dist/lib/utils/component.d.ts", - "line": 52, - "character": 4 - } - ], - "signatures": [ - { - "id": 662, - "name": "new MarkdownTheme", - "variant": "signature", - "kind": 16384, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create new Component instance." - } - ] - }, - "sources": [ - { - "fileName": "node_modules/typedoc/dist/lib/utils/component.d.ts", - "line": 52, - "character": 4 - } - ], - "parameters": [ - { - "id": 663, - "name": "owner", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/output/renderer.d.ts", - "qualifiedName": "Renderer" - }, - "name": "Renderer", - "package": "typedoc" - } - } - ], - "type": { - "type": "reference", - "target": 660, - "name": "MarkdownTheme", - "package": "typedoc-plugin-markdown" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Theme.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Theme.constructor" - } - }, - { - "id": 664, - "name": "render", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 47, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L47" - } - ], - "signatures": [ - { - "id": 665, - "name": "render", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Renders a template and page model to a string." - } - ], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 47, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L47" - } - ], - "parameters": [ - { - "id": 666, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 667, - "name": "template", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 710, - "typeArguments": [ - { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - ], - "name": "RenderTemplate", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Theme.render" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Theme.render" - } - }, - { - "id": 668, - "name": "getRenderContext", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 64, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L64" - } - ], - "signatures": [ - { - "id": 669, - "name": "getRenderContext", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new instance of the current theme context.\n\nThis method can be overridden to provide an alternative theme context." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 64, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L64" - } - ], - "parameters": [ - { - "id": 670, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "reference", - "target": 634, - "name": "MarkdownThemeContext", - "package": "typedoc-plugin-markdown" - } - } - ] - }, - { - "id": 671, - "name": "getUrls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 73, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L73" - } - ], - "signatures": [ - { - "id": 672, - "name": "getUrls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maps the models of the given project to the desired output files.\n\nThis method can be overriden to provide an alternative url structure." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 73, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L73" - } - ], - "parameters": [ - { - "id": 673, - "name": "project", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 697, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/abstract.d.ts", - "qualifiedName": "Reflection" - }, - "name": "Reflection", - "package": "typedoc" - } - ], - "name": "UrlMapping", - "package": "typedoc-plugin-markdown" - } - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Theme.getUrls" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Theme.getUrls" - } - }, - { - "id": 674, - "name": "getNavigation", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 82, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L82" - } - ], - "signatures": [ - { - "id": 675, - "name": "getNavigation", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Map the models of the given project to a navigation structure.\n\nThis method can be overriden to provide an alternative navigation structure." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 82, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L82" - } - ], - "parameters": [ - { - "id": 676, - "name": "project", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 705, - "name": "NavigationItem", - "package": "typedoc-plugin-markdown" - } - } - } - ] - }, - { - "id": 677, - "name": "getTemplateMapping", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 89, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L89" - } - ], - "signatures": [ - { - "id": 678, - "name": "getTemplateMapping", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 89, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L89" - } - ], - "parameters": [ - { - "id": 679, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/kind.d.ts", - "qualifiedName": "ReflectionKind" - }, - "name": "ReflectionKind", - "package": "typedoc" - } - }, - { - "id": 680, - "name": "outputFileStrategy", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 111, - "name": "OutputFileStrategy", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 681, - "name": "documentTemplate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 213, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L213" - } - ], - "signatures": [ - { - "id": 682, - "name": "documentTemplate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 213, - "character": 21, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L213" - } - ], - "parameters": [ - { - "id": 683, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/document.d.ts", - "qualifiedName": "DocumentReflection" - }, - "name": "DocumentReflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 684, - "name": "readmeTemplate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 220, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L220" - } - ], - "signatures": [ - { - "id": 685, - "name": "readmeTemplate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 220, - "character": 19, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L220" - } - ], - "parameters": [ - { - "id": 686, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 687, - "name": "projectTemplate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 227, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L227" - } - ], - "signatures": [ - { - "id": 688, - "name": "projectTemplate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 227, - "character": 20, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L227" - } - ], - "parameters": [ - { - "id": 689, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/project.d.ts", - "qualifiedName": "ProjectReflection" - }, - "name": "ProjectReflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 690, - "name": "reflectionTemplate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 234, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L234" - } - ], - "signatures": [ - { - "id": 691, - "name": "reflectionTemplate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@internal" - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 234, - "character": 23, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L234" - } - ], - "parameters": [ - { - "id": 692, - "name": "page", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/declaration.d.ts", - "qualifiedName": "DeclarationReflection" - }, - "name": "DeclarationReflection", - "package": "typedoc" - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 661 - ] - }, - { - "title": "Methods", - "children": [ - 664, - 668, - 671, - 674, - 677, - 681, - 684, - 687, - 690 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "line": 41, - "character": 13, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L41" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/output/theme.d.ts", - "qualifiedName": "Theme" - }, - "name": "Theme", - "package": "typedoc" - } - ] - }, - { - "id": 693, - "name": "types", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 694, - "name": "PackageMetaData", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The model used to define the package metadata when in packages mode." - } - ] - }, - "children": [ - { - "id": 695, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 10, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L10" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 696, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 11, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L11" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/options/options.d.ts", - "qualifiedName": "Options" - }, - "name": "Options", - "package": "typedoc" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 695, - 696 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 9, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L9" - } - ] - }, - { - "id": 697, - "name": "UrlMapping", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The model used to define the URL mapping structure." - } - ] - }, - "children": [ - { - "id": 698, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 699, - "name": "model", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 20, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L20" - } - ], - "type": { - "type": "reference", - "target": 704, - "name": "Model", - "package": "typedoc-plugin-markdown", - "qualifiedName": "UrlMapping.Model", - "refersToTypeParameter": true - } - }, - { - "id": 700, - "name": "template", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 21, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L21" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 701, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 21, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L21" - } - ], - "signatures": [ - { - "id": 702, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 21, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L21" - } - ], - "parameters": [ - { - "id": 703, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": 704, - "name": "Model", - "package": "typedoc-plugin-markdown", - "qualifiedName": "UrlMapping.Model", - "refersToTypeParameter": true - } - ], - "name": "MarkdownPageEvent", - "package": "typedoc-plugin-markdown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 698, - 699, - 700 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 18, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L18" - } - ], - "typeParameters": [ - { - "id": 704, - "name": "Model", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ] - }, - { - "id": 705, - "name": "NavigationItem", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The model used to define the navigation structure." - } - ] - }, - "children": [ - { - "id": 706, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 29, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L29" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 707, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 30, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L30" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 708, - "name": "kind", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L31" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/kind.d.ts", - "qualifiedName": "ReflectionKind" - }, - "name": "ReflectionKind", - "package": "typedoc" - } - }, - { - "id": 709, - "name": "children", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 32, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L32" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 705, - "name": "NavigationItem", - "package": "typedoc-plugin-markdown" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 706, - 707, - 708, - 709 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 28, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L28" - } - ] - }, - { - "id": 710, - "name": "RenderTemplate", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 35, - "character": 12, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L35" - } - ], - "typeParameters": [ - { - "id": 711, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 712, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 35, - "character": 32, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L35" - } - ], - "signatures": [ - { - "id": 713, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 714, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 711, - "name": "T", - "package": "typedoc-plugin-markdown", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 715, - "name": "TemplateMapping", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 716, - "name": "directory", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 717, - "name": "template", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 39, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L39" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 718, - "name": "kind", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 40, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L40" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/models/reflections/kind.d.ts", - "qualifiedName": "ReflectionKind" - }, - "name": "ReflectionKind", - "package": "typedoc" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 716, - 717, - 718 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 37, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L37" - } - ] - }, - { - "id": 719, - "name": "UrlOption", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 720, - "name": "parentUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 44, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 721, - "name": "directory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 45, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L45" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 722, - "name": "forceDirectory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 46, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L46" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 723, - "name": "outputFileStrategy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 47, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L47" - } - ], - "type": { - "type": "reference", - "target": 111, - "name": "OutputFileStrategy", - "package": "typedoc-plugin-markdown" - } - }, - { - "id": 724, - "name": "entryModule", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 48, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L48" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 725, - "name": "entryFileName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 49, - "character": 2, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L49" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 720, - 721, - 722, - 723, - 724, - 725 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 43, - "character": 17, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L43" - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 694, - 697, - 705, - 715, - 719 - ] - }, - { - "title": "Type Aliases", - "children": [ - 710 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/types.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Namespaces", - "children": [ - 196, - 612, - 693 - ] - }, - { - "title": "Classes", - "children": [ - 634, - 660 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/theme/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/theme/index.ts#L1" - } - ] - }, - { - "id": 726, - "name": "libs", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "General pure library functions to be consumed across the plugin." - } - ] - }, - "children": [ - { - "id": 727, - "name": "markdown", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helpers to render markdown elements." - } - ] - }, - "children": [ - { - "id": 728, - "name": "backTicks", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L7" - } - ], - "signatures": [ - { - "id": 729, - "name": "backTicks", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps a string in backticks.\nIf the input string itself contains a backtick, pipe, or backslash (which can result in unwanted side effects) the string is escaped instead." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L7" - } - ], - "parameters": [ - { - "id": 730, - "name": "text", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 731, - "name": "blockQuoteBlock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1" - } - ], - "signatures": [ - { - "id": 732, - "name": "blockQuoteBlock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1" - } - ], - "parameters": [ - { - "id": 733, - "name": "content", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 734, - "name": "bold", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1" - } - ], - "signatures": [ - { - "id": 735, - "name": "bold", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1" - } - ], - "parameters": [ - { - "id": 736, - "name": "text", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 737, - "name": "codeBlock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3" - } - ], - "signatures": [ - { - "id": 738, - "name": "codeBlock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3" - } - ], - "parameters": [ - { - "id": 739, - "name": "content", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 740, - "name": "heading", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6" - } - ], - "signatures": [ - { - "id": 741, - "name": "heading", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a heading in markdown format" - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6" - } - ], - "parameters": [ - { - "id": 742, - "name": "level", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The level of the heading" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 743, - "name": "text", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The text of the heading" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 744, - "name": "horizontalRule", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1" - } - ], - "signatures": [ - { - "id": 745, - "name": "horizontalRule", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 746, - "name": "htmlTable", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1" - } - ], - "signatures": [ - { - "id": 747, - "name": "htmlTable", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1" - } - ], - "parameters": [ - { - "id": 748, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 749, - "name": "rows", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - { - "id": 750, - "name": "leftAlignHeadings", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 751, - "name": "indentBlock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1" - } - ], - "signatures": [ - { - "id": 752, - "name": "indentBlock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1" - } - ], - "parameters": [ - { - "id": 753, - "name": "content", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 754, - "name": "italic", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1" - } - ], - "signatures": [ - { - "id": 755, - "name": "italic", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1" - } - ], - "parameters": [ - { - "id": 756, - "name": "text", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 757, - "name": "link", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/link.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6" - } - ], - "signatures": [ - { - "id": 758, - "name": "link", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The link element" - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/link.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6" - } - ], - "parameters": [ - { - "id": 759, - "name": "label", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The text to display for the link" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 760, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The url to link to" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 761, - "name": "strikeThrough", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1" - } - ], - "signatures": [ - { - "id": 762, - "name": "strikeThrough", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1" - } - ], - "parameters": [ - { - "id": 763, - "name": "content", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 764, - "name": "table", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/table.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7" - } - ], - "signatures": [ - { - "id": 765, - "name": "table", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comments for table" - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/table.ts", - "line": 7, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7" - } - ], - "parameters": [ - { - "id": 766, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 767, - "name": "rows", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - { - "id": 768, - "name": "headerLeftAlign", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 769, - "name": "unorderedList", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1" - } - ], - "signatures": [ - { - "id": 770, - "name": "unorderedList", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1" - } - ], - "parameters": [ - { - "id": 771, - "name": "items", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 728, - 731, - 734, - 737, - 740, - 744, - 746, - 751, - 754, - 757, - 761, - 764, - 769 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/markdown/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/markdown/index.ts#L1" - } - ] - }, - { - "id": 772, - "name": "utils", - "variant": "declaration", - "kind": 4, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "General utility pure functions." - } - ] - }, - "children": [ - { - "id": 773, - "name": "camelToTitleCase", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1" - } - ], - "signatures": [ - { - "id": 774, - "name": "camelToTitleCase", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1" - } - ], - "parameters": [ - { - "id": 775, - "name": "text", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 776, - "name": "escapeChars", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1" - } - ], - "signatures": [ - { - "id": 777, - "name": "escapeChars", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1" - } - ], - "parameters": [ - { - "id": 778, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 779, - "name": "formatMarkdown", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1" - } - ], - "signatures": [ - { - "id": 780, - "name": "formatMarkdown", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1" - } - ], - "parameters": [ - { - "id": 781, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 782, - "name": "formatTableCell", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6" - } - ], - "signatures": [ - { - "id": 783, - "name": "formatTableCell", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "- Replace new lines with spaces\n- Replaces code blocks with single backticks\n- Replaces multiple spaces with single spaces" - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6" - } - ], - "parameters": [ - { - "id": 784, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 785, - "name": "getFileNameWithExtension", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6" - } - ], - "signatures": [ - { - "id": 786, - "name": "getFileNameWithExtension", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a filename with extension while normalizing both the input name and input extension." - } - ] - }, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts", - "line": 6, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6" - } - ], - "parameters": [ - { - "id": 787, - "name": "fileName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "name": "fileExtension", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 789, - "name": "isQuoted", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1" - } - ], - "signatures": [ - { - "id": 790, - "name": "isQuoted", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1" - } - ], - "parameters": [ - { - "id": 791, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 792, - "name": "normalizeLineBreaks", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts#L1" - } - ], - "signatures": [ - { - "id": 793, - "name": "normalizeLineBreaks", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts#L1" - } - ], - "parameters": [ - { - "id": 794, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 795, - "name": "removeFirstScopedDirectory", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3" - } - ], - "signatures": [ - { - "id": 796, - "name": "removeFirstScopedDirectory", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts", - "line": 3, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3" - } - ], - "parameters": [ - { - "id": 797, - "name": "urlString", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 798, - "name": "removeLineBreaks", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1" - } - ], - "signatures": [ - { - "id": 799, - "name": "removeLineBreaks", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1" - } - ], - "parameters": [ - { - "id": 800, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 801, - "name": "sanitizeComments", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1" - } - ], - "signatures": [ - { - "id": 802, - "name": "sanitizeComments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1" - } - ], - "parameters": [ - { - "id": 803, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 804, - "name": "slugify", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1" - } - ], - "signatures": [ - { - "id": 805, - "name": "slugify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1" - } - ], - "parameters": [ - { - "id": 806, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 807, - "name": "toPascalCase", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1" - } - ], - "signatures": [ - { - "id": 808, - "name": "toPascalCase", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1" - } - ], - "parameters": [ - { - "id": 809, - "name": "text", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 810, - "name": "unEscapeChars", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1" - } - ], - "signatures": [ - { - "id": 811, - "name": "unEscapeChars", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts", - "line": 1, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1" - } - ], - "parameters": [ - { - "id": 812, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 773, - 776, - 779, - 782, - 785, - 789, - 792, - 795, - 798, - 801, - 804, - 807, - 810 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/utils/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/utils/index.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Namespaces", - "children": [ - 727, - 772 - ] - } - ], - "sources": [ - { - "fileName": "packages/typedoc-plugin-markdown/src/libs/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-markdown/src/libs/index.ts#L1" - } - ] - } - ], - "documents": [ - { - "id": 813, - "name": "Quick Start", - "variant": "document", - "kind": 8388608, - "flags": {}, - "content": [ - { - "kind": "text", - "text": "# QUICK START" - } - ], - "frontmatter": {} - } - ], - "childrenIncludingDocuments": [ - 813, - 2, - 70, - 171, - 195, - 726 - ], - "groups": [ - { - "title": "Documents" - }, - { - "title": "Modules", - "children": [ - 2, - 70, - 171, - 195, - 726 - ] - } - ], - "readme": [ - { - "kind": "text", - "text": "# typedoc-plugin-markdown\n\n[![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-markdown) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.yml)\n\n> A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.\n\n## Installation\n\n" - }, - { - "kind": "code", - "text": "```shell\n npm install typedoc-plugin-markdown --save-dev\n ```" - }, - { - "kind": "text", - "text": "\n\n## Documentation\n\nPlease visit the [https://typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org) for comprehensive documentation, including options and usage guides.\n\n## License\n\nMIT" - } - ] - }, - { - "id": 814, - "name": "typedoc-plugin-frontmatter", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Docs for " - }, - { - "kind": "code", - "text": "`lib`" - }, - { - "kind": "text", - "text": " module" - } - ] - }, - "children": [ - { - "id": 815, - "name": "load", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "index.ts", - "line": 18, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-frontmatter/src/index.ts#L18" - } - ], - "signatures": [ - { - "id": 816, - "name": "load", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "index.ts", - "line": 18, - "character": 16, - "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/blob/a350891d3362a78bb12907d480645f9c5cefd0d6/packages/typedoc-plugin-frontmatter/src/index.ts#L18" - } - ], - "parameters": [ - { - "id": 817, - "name": "app", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typedoc/dist/lib/application.d.ts", - "qualifiedName": "Application" - }, - "name": "Application", - "package": "typedoc" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 815 - ] - } - ], - "readme": [ - { - "kind": "text", - "text": "# typedoc-plugin-frontmatter\n\n[![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-frontmatter) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-plugin-frontmatter.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-plugin-frontmatter.yml)\n\n> A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content.\n\n## Installation\n\n" - }, - { - "kind": "code", - "text": "```shell\n npm install typedoc-plugin-frontmatter --save-dev\n ```" - }, - { - "kind": "text", - "text": "\n\n## Documentation\n\nPlease visit the [https://typedoc-plugin-markdown.org/plugins/frontmatter](https://typedoc-plugin-markdown.org/plugins/frontmatter) for comprehensive documentation, including options and usage guides.\n\n## License\n\nMIT" - } - ] - } - ], - "symbolIdMap": { - "2": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/index.ts", - "qualifiedName": "" - }, - "3": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/_initialize.ts", - "qualifiedName": "" - }, - "4": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/_initialize.ts", - "qualifiedName": "load" - }, - "5": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/_initialize.ts", - "qualifiedName": "load" - }, - "6": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/_initialize.ts", - "qualifiedName": "app" - }, - "7": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/index.ts", - "qualifiedName": "" - }, - "8": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent" - }, - "9": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.project" - }, - "10": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.model" - }, - "11": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.contents" - }, - "12": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.url" - }, - "13": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.filename" - }, - "14": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.frontmatter" - }, - "15": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.BEGIN" - }, - "16": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.END" - }, - "17": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts", - "qualifiedName": "MarkdownPageEvent.Model" - }, - "18": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "qualifiedName": "MarkdownRendererEvent" - }, - "19": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "qualifiedName": "MarkdownRendererEvent.project" - }, - "20": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "qualifiedName": "MarkdownRendererEvent.outputDirectory" - }, - "21": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "qualifiedName": "MarkdownRendererEvent.urls" - }, - "22": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "qualifiedName": "MarkdownRendererEvent.navigation" - }, - "23": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "qualifiedName": "MarkdownRendererEvent.BEGIN" - }, - "24": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts", - "qualifiedName": "MarkdownRendererEvent.END" - }, - "25": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "" - }, - "26": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "generateDocs" - }, - "27": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "generateDocs" - }, - "28": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "project" - }, - "29": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "out" - }, - "30": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "render" - }, - "31": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "render" - }, - "32": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "project" - }, - "33": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "outputDirectory" - }, - "34": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "resolvePackages" - }, - "35": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "resolvePackages" - }, - "36": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "app" - }, - "37": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "context" - }, - "38": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "qualifiedName": "packageDir" - }, - "39": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/index.ts", - "qualifiedName": "" - }, - "40": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts", - "qualifiedName": "MarkdownApplication" - }, - "41": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts", - "qualifiedName": "MarkdownApplication.renderer" - }, - "42": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "qualifiedName": "MarkdownRendererHooks" - }, - "43": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "qualifiedName": "MarkdownRendererHooks.page.begin" - }, - "44": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "qualifiedName": "MarkdownRendererHooks.page.end" - }, - "45": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "qualifiedName": "MarkdownRendererHooks.content.begin" - }, - "46": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "qualifiedName": "MarkdownRendererHooks.index.page.begin" - }, - "47": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts", - "qualifiedName": "MarkdownRendererHooks.index.page.end" - }, - "48": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "MarkdownRenderer" - }, - "49": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "MarkdownRenderer.markdownHooks" - }, - "50": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "MarkdownRenderer.packagesMeta" - }, - "51": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "52": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type.description" - }, - "53": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type.options" - }, - "54": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "MarkdownRenderer.defineTheme" - }, - "55": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "56": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "57": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "name" - }, - "58": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "theme" - }, - "59": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "60": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "61": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "renderer" - }, - "62": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "MarkdownRenderer.preRenderAsyncJobs" - }, - "63": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "64": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "65": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "output" - }, - "66": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "MarkdownRenderer.postRenderAsyncJobs" - }, - "67": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "__type" - }, - "69": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts", - "qualifiedName": "output" - }, - "70": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/index.ts", - "qualifiedName": "" - }, - "71": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "" - }, - "72": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "ALLOWED_OWN_FILE_MEMBERS" - }, - "73": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "TEXT_CONTENT_MAPPINGS" - }, - "74": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "__object" - }, - "75": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "__object.header.title" - }, - "76": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "__object.header.docs" - }, - "77": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "__object.breadcrumbs.home" - }, - "78": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "__object.title.indexPage" - }, - "79": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "__object.title.memberPage" - }, - "80": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "qualifiedName": "__object.footer.text" - }, - "81": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "" - }, - "82": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "outputFileStrategy" - }, - "83": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "membersWithOwnFile" - }, - "84": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "flattenOutputFiles" - }, - "85": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "fileExtension" - }, - "86": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "entryFileName" - }, - "87": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "entryModule" - }, - "88": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "excludeScopesInPaths" - }, - "89": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "mergeReadme" - }, - "90": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "hidePageHeader" - }, - "91": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "hidePageTitle" - }, - "92": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "hideBreadcrumbs" - }, - "93": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "hideGroupHeadings" - }, - "94": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "useCodeBlocks" - }, - "95": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "expandObjects" - }, - "96": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "expandParameters" - }, - "97": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "parametersFormat" - }, - "98": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "propertiesFormat" - }, - "99": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "enumMembersFormat" - }, - "100": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "typeDeclarationFormat" - }, - "101": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "indexFormat" - }, - "102": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "tableColumnSettings" - }, - "103": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "publicPath" - }, - "104": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "sanitizeComments" - }, - "105": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "anchorPrefix" - }, - "106": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "useHTMLAnchors" - }, - "107": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "preserveAnchorCasing" - }, - "108": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "navigationModel" - }, - "109": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "qualifiedName": "textContentMappings" - }, - "110": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "" - }, - "111": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "OutputFileStrategy" - }, - "112": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "OutputFileStrategy.Members" - }, - "113": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "OutputFileStrategy.Modules" - }, - "114": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "ReflectionFormat" - }, - "115": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "ReflectionFormat.List" - }, - "116": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "ReflectionFormat.Table" - }, - "117": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "ReflectionFormat.HtmlTable" - }, - "118": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "IndexFormat" - }, - "119": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "IndexFormat.List" - }, - "120": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "qualifiedName": "IndexFormat.Table" - }, - "121": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "" - }, - "122": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions" - }, - "123": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.anchorPrefix" - }, - "124": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.entryFileName" - }, - "125": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.entryModule" - }, - "126": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.enumMembersFormat" - }, - "127": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.excludeGroups" - }, - "128": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.excludeScopesInPaths" - }, - "129": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.expandObjects" - }, - "130": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.expandParameters" - }, - "131": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.fileExtension" - }, - "132": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.flattenOutputFiles" - }, - "133": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.hideBreadcrumbs" - }, - "134": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.hideGroupHeadings" - }, - "135": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.hidePageHeader" - }, - "136": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.hidePageTitle" - }, - "137": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.indexFormat" - }, - "138": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.membersWithOwnFile" - }, - "139": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.mergeReadme" - }, - "140": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.navigationModel" - }, - "141": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type" - }, - "142": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.excludeGroups" - }, - "143": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.excludeCategories" - }, - "144": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.excludeFolders" - }, - "145": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.outputFileStrategy" - }, - "146": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.parametersFormat" - }, - "147": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.preserveAnchorCasing" - }, - "148": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.propertiesFormat" - }, - "149": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.publicPath" - }, - "150": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.sanitizeComments" - }, - "151": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.tableColumnSettings" - }, - "152": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type" - }, - "153": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.hideDefaults" - }, - "154": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.hideInherited" - }, - "155": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.hideModifiers" - }, - "156": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.hideOverrides" - }, - "157": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.hideSources" - }, - "158": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.hideValues" - }, - "159": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.leftAlignHeaders" - }, - "160": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.textContentMappings" - }, - "161": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type" - }, - "162": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.header.title" - }, - "163": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.header.docs" - }, - "164": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.breadcrumbs.home" - }, - "165": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.title.indexPage" - }, - "166": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.title.memberPage" - }, - "167": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "__type.footer.text" - }, - "168": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.typeDeclarationFormat" - }, - "169": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.useCodeBlocks" - }, - "170": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/options/types.ts", - "qualifiedName": "PluginOptions.useHTMLAnchors" - }, - "171": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/index.ts", - "qualifiedName": "" - }, - "172": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts", - "qualifiedName": "" - }, - "173": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts", - "qualifiedName": "translatable" - }, - "174": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts", - "qualifiedName": "translatable" - }, - "175": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/translatable.ts", - "qualifiedName": "" - }, - "176": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/translatable.ts", - "qualifiedName": "getTranslatable" - }, - "177": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/translatable.ts", - "qualifiedName": "getTranslatable" - }, - "178": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/translatable.ts", - "qualifiedName": "app" - }, - "179": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "" - }, - "180": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings" - }, - "181": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_default_value" - }, - "182": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_default_type" - }, - "183": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_description" - }, - "184": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_event" - }, - "185": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_extends" - }, - "186": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_extended_by" - }, - "187": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_member" - }, - "188": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_member_plural" - }, - "189": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_modifier" - }, - "190": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_name" - }, - "191": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_packages" - }, - "192": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_type" - }, - "193": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_value" - }, - "194": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "qualifiedName": "TranslatableStrings.theme_version" - }, - "195": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/index.ts", - "qualifiedName": "" - }, - "196": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/index.ts", - "qualifiedName": "" - }, - "197": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/index.ts", - "qualifiedName": "" - }, - "198": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "qualifiedName": "getCommentParts" - }, - "199": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "qualifiedName": "getCommentParts" - }, - "200": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "qualifiedName": "this" - }, - "201": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "qualifiedName": "model" - }, - "202": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "qualifiedName": "isFile" - }, - "203": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "qualifiedName": "isFile" - }, - "204": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts", - "qualifiedName": "file" - }, - "205": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts", - "qualifiedName": "getDeclarationType" - }, - "206": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts", - "qualifiedName": "getDeclarationType" - }, - "207": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-declaration-type.ts", - "qualifiedName": "model" - }, - "208": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts", - "qualifiedName": "getDescriptionForReflection" - }, - "209": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts", - "qualifiedName": "getDescriptionForReflection" - }, - "210": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts", - "qualifiedName": "this" - }, - "211": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts", - "qualifiedName": "model" - }, - "212": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "qualifiedName": "getFlattenedDeclarations" - }, - "213": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "qualifiedName": "getFlattenedDeclarations" - }, - "214": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "qualifiedName": "model" - }, - "215": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "qualifiedName": "options" - }, - "216": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "qualifiedName": "__type" - }, - "217": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-flattened-declarations.ts", - "qualifiedName": "__type.includeSignatures" - }, - "218": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts", - "qualifiedName": "getGroupIndexList" - }, - "219": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts", - "qualifiedName": "getGroupIndexList" - }, - "220": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts", - "qualifiedName": "this" - }, - "221": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-list.ts", - "qualifiedName": "children" - }, - "222": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts", - "qualifiedName": "getGroupIndexTable" - }, - "223": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts", - "qualifiedName": "getGroupIndexTable" - }, - "224": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts", - "qualifiedName": "this" - }, - "225": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts", - "qualifiedName": "children" - }, - "226": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index-table.ts", - "qualifiedName": "kind" - }, - "227": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts", - "qualifiedName": "getGroupIndex" - }, - "228": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts", - "qualifiedName": "getGroupIndex" - }, - "229": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-group-index.ts", - "qualifiedName": "group" - }, - "230": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "qualifiedName": "getHierarchyType" - }, - "231": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "qualifiedName": "getHierarchyType" - }, - "232": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "qualifiedName": "this" - }, - "233": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "qualifiedName": "model" - }, - "234": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "qualifiedName": "options" - }, - "235": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "qualifiedName": "__type" - }, - "236": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-hierarchy-type.ts", - "qualifiedName": "__type.isTarget" - }, - "237": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts", - "qualifiedName": "getKeyword" - }, - "238": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts", - "qualifiedName": "getKeyword" - }, - "239": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-keyword.ts", - "qualifiedName": "model" - }, - "240": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts", - "qualifiedName": "getModifier" - }, - "241": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts", - "qualifiedName": "getModifier" - }, - "242": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-modifier.ts", - "qualifiedName": "model" - }, - "243": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts", - "qualifiedName": "getParameterDefaultValue" - }, - "244": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts", - "qualifiedName": "getParameterDefaultValue" - }, - "245": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-parameter-default-value.ts", - "qualifiedName": "model" - }, - "246": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts", - "qualifiedName": "getProjectName" - }, - "247": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts", - "qualifiedName": "getProjectName" - }, - "248": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts", - "qualifiedName": "stringWithPlaceholders" - }, - "249": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts", - "qualifiedName": "page" - }, - "250": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts", - "qualifiedName": "getPropertyDefaultValue" - }, - "251": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts", - "qualifiedName": "getPropertyDefaultValue" - }, - "252": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts", - "qualifiedName": "model" - }, - "253": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts", - "qualifiedName": "getReflectionFlags" - }, - "254": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts", - "qualifiedName": "getReflectionFlags" - }, - "255": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts", - "qualifiedName": "this" - }, - "256": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts", - "qualifiedName": "reflection" - }, - "257": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts", - "qualifiedName": "getReturnType" - }, - "258": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts", - "qualifiedName": "getReturnType" - }, - "259": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts", - "qualifiedName": "this" - }, - "260": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/get-return-type.ts", - "qualifiedName": "model" - }, - "261": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts", - "qualifiedName": "isGroupKind" - }, - "262": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts", - "qualifiedName": "isGroupKind" - }, - "263": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/is-group-kind.ts", - "qualifiedName": "model" - }, - "264": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts", - "qualifiedName": "useTableFormat" - }, - "265": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts", - "qualifiedName": "useTableFormat" - }, - "266": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts", - "qualifiedName": "this" - }, - "267": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts", - "qualifiedName": "key" - }, - "268": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/index.ts", - "qualifiedName": "" - }, - "269": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "comment" - }, - "270": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "comment" - }, - "271": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "this" - }, - "272": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "model" - }, - "273": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "options" - }, - "274": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "__type" - }, - "275": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "__type.headingLevel" - }, - "276": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "__type.showSummary" - }, - "277": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "__type.showTags" - }, - "278": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts", - "qualifiedName": "__type.isTableColumn" - }, - "279": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "qualifiedName": "commentParts" - }, - "280": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "qualifiedName": "commentParts" - }, - "281": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "qualifiedName": "this" - }, - "282": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "qualifiedName": "model" - }, - "283": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "qualifiedName": "isFile" - }, - "284": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "qualifiedName": "isFile" - }, - "285": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts", - "qualifiedName": "file" - }, - "286": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "qualifiedName": "body" - }, - "287": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "qualifiedName": "body" - }, - "288": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "qualifiedName": "this" - }, - "289": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "qualifiedName": "model" - }, - "290": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "qualifiedName": "options" - }, - "291": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "qualifiedName": "__type" - }, - "292": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts", - "qualifiedName": "__type.headingLevel" - }, - "293": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "qualifiedName": "categories" - }, - "294": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "qualifiedName": "categories" - }, - "295": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "qualifiedName": "this" - }, - "296": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "qualifiedName": "model" - }, - "297": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "qualifiedName": "options" - }, - "298": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "qualifiedName": "__type" - }, - "299": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts", - "qualifiedName": "__type.headingLevel" - }, - "300": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "qualifiedName": "groups" - }, - "301": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "qualifiedName": "groups" - }, - "302": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "qualifiedName": "this" - }, - "303": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "qualifiedName": "model" - }, - "304": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "qualifiedName": "options" - }, - "305": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "qualifiedName": "__type" - }, - "306": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts", - "qualifiedName": "__type.headingLevel" - }, - "307": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "qualifiedName": "members" - }, - "308": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "qualifiedName": "members" - }, - "309": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "qualifiedName": "this" - }, - "310": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "qualifiedName": "model" - }, - "311": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "qualifiedName": "options" - }, - "312": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "qualifiedName": "__type" - }, - "313": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/container.members.ts", - "qualifiedName": "__type.headingLevel" - }, - "314": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "qualifiedName": "accessor" - }, - "315": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "qualifiedName": "accessor" - }, - "316": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "qualifiedName": "this" - }, - "317": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "qualifiedName": "model" - }, - "318": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "qualifiedName": "options" - }, - "319": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "qualifiedName": "__type" - }, - "320": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts", - "qualifiedName": "__type.headingLevel" - }, - "321": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "qualifiedName": "constructor" - }, - "322": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "qualifiedName": "constructor" - }, - "323": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "qualifiedName": "this" - }, - "324": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "qualifiedName": "model" - }, - "325": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "qualifiedName": "options" - }, - "326": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "qualifiedName": "__type" - }, - "327": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts", - "qualifiedName": "__type.headingLevel" - }, - "328": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "qualifiedName": "memberContainer" - }, - "329": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "qualifiedName": "memberContainer" - }, - "330": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "qualifiedName": "this" - }, - "331": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "qualifiedName": "model" - }, - "332": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "qualifiedName": "options" - }, - "333": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "qualifiedName": "__type" - }, - "334": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "qualifiedName": "__type.headingLevel" - }, - "335": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.container.ts", - "qualifiedName": "__type.nested" - }, - "336": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "qualifiedName": "declaration" - }, - "337": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "qualifiedName": "declaration" - }, - "338": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "qualifiedName": "this" - }, - "339": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "qualifiedName": "model" - }, - "340": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "qualifiedName": "options" - }, - "341": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "qualifiedName": "__type" - }, - "342": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "qualifiedName": "__type.headingLevel" - }, - "343": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts", - "qualifiedName": "__type.nested" - }, - "344": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts", - "qualifiedName": "declarationTitle" - }, - "345": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts", - "qualifiedName": "declarationTitle" - }, - "346": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts", - "qualifiedName": "this" - }, - "347": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts", - "qualifiedName": "model" - }, - "348": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "qualifiedName": "documents" - }, - "349": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "qualifiedName": "documents" - }, - "350": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "qualifiedName": "this" - }, - "351": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "qualifiedName": "model" - }, - "352": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "qualifiedName": "options" - }, - "353": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "qualifiedName": "__type" - }, - "354": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.documents.ts", - "qualifiedName": "__type.headingLevel" - }, - "355": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts", - "qualifiedName": "enumMembersTable" - }, - "356": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts", - "qualifiedName": "enumMembersTable" - }, - "357": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts", - "qualifiedName": "this" - }, - "358": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.enumMembersTable.ts", - "qualifiedName": "model" - }, - "359": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "qualifiedName": "hierarchy" - }, - "360": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "qualifiedName": "hierarchy" - }, - "361": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "qualifiedName": "this" - }, - "362": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "qualifiedName": "model" - }, - "363": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "qualifiedName": "options" - }, - "364": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "qualifiedName": "__type" - }, - "365": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.hierarchy.ts", - "qualifiedName": "__type.headingLevel" - }, - "366": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts", - "qualifiedName": "indexSignature" - }, - "367": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts", - "qualifiedName": "indexSignature" - }, - "368": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts", - "qualifiedName": "this" - }, - "369": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts", - "qualifiedName": "model" - }, - "370": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "qualifiedName": "inheritance" - }, - "371": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "qualifiedName": "inheritance" - }, - "372": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "qualifiedName": "this" - }, - "373": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "qualifiedName": "model" - }, - "374": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "qualifiedName": "options" - }, - "375": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "qualifiedName": "__type" - }, - "376": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.inheritance.ts", - "qualifiedName": "__type.headingLevel" - }, - "377": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts", - "qualifiedName": "memberTitle" - }, - "378": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts", - "qualifiedName": "memberTitle" - }, - "379": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts", - "qualifiedName": "this" - }, - "380": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts", - "qualifiedName": "model" - }, - "381": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "qualifiedName": "memberWithGroups" - }, - "382": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "qualifiedName": "memberWithGroups" - }, - "383": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "qualifiedName": "this" - }, - "384": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "qualifiedName": "model" - }, - "385": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "qualifiedName": "options" - }, - "386": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "qualifiedName": "__type" - }, - "387": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts", - "qualifiedName": "__type.headingLevel" - }, - "388": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts", - "qualifiedName": "parametersList" - }, - "389": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts", - "qualifiedName": "parametersList" - }, - "390": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts", - "qualifiedName": "this" - }, - "391": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersList.ts", - "qualifiedName": "model" - }, - "392": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts", - "qualifiedName": "parametersTable" - }, - "393": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts", - "qualifiedName": "parametersTable" - }, - "394": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts", - "qualifiedName": "this" - }, - "395": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.parametersTable.ts", - "qualifiedName": "model" - }, - "396": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "qualifiedName": "propertiesTable" - }, - "397": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "qualifiedName": "propertiesTable" - }, - "398": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "qualifiedName": "this" - }, - "399": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "qualifiedName": "model" - }, - "400": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "qualifiedName": "options" - }, - "401": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "qualifiedName": "__type" - }, - "402": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts", - "qualifiedName": "__type.isEventProps" - }, - "403": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts", - "qualifiedName": "referenceMember" - }, - "404": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts", - "qualifiedName": "referenceMember" - }, - "405": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts", - "qualifiedName": "this" - }, - "406": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reference.ts", - "qualifiedName": "model" - }, - "407": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "qualifiedName": "reflectionIndex" - }, - "408": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "qualifiedName": "reflectionIndex" - }, - "409": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "qualifiedName": "this" - }, - "410": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "qualifiedName": "model" - }, - "411": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "qualifiedName": "options" - }, - "412": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "qualifiedName": "__type" - }, - "413": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts", - "qualifiedName": "__type.headingLevel" - }, - "414": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "signature" - }, - "415": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "signature" - }, - "416": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "this" - }, - "417": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "model" - }, - "418": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "options" - }, - "419": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "__type" - }, - "420": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "__type.headingLevel" - }, - "421": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "__type.nested" - }, - "422": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "__type.accessor" - }, - "423": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts", - "qualifiedName": "__type.multipleSignatures" - }, - "424": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts", - "qualifiedName": "signatureParameters" - }, - "425": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts", - "qualifiedName": "signatureParameters" - }, - "426": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts", - "qualifiedName": "this" - }, - "427": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureParameters.ts", - "qualifiedName": "model" - }, - "428": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "qualifiedName": "signatureReturns" - }, - "429": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "qualifiedName": "signatureReturns" - }, - "430": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "qualifiedName": "this" - }, - "431": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "qualifiedName": "model" - }, - "432": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "qualifiedName": "options" - }, - "433": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "qualifiedName": "__type" - }, - "434": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts", - "qualifiedName": "__type.headingLevel" - }, - "435": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "qualifiedName": "signatureTitle" - }, - "436": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "qualifiedName": "signatureTitle" - }, - "437": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "qualifiedName": "this" - }, - "438": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "qualifiedName": "model" - }, - "439": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "qualifiedName": "options" - }, - "440": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "qualifiedName": "__type" - }, - "441": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "qualifiedName": "__type.accessor" - }, - "442": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts", - "qualifiedName": "__type.includeType" - }, - "443": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "qualifiedName": "signatures" - }, - "444": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "qualifiedName": "signatures" - }, - "445": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "qualifiedName": "this" - }, - "446": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "qualifiedName": "model" - }, - "447": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "qualifiedName": "options" - }, - "448": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "qualifiedName": "__type" - }, - "449": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "qualifiedName": "__type.headingLevel" - }, - "450": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatures.ts", - "qualifiedName": "__type.nested" - }, - "451": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "qualifiedName": "sources" - }, - "452": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "qualifiedName": "sources" - }, - "453": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "qualifiedName": "this" - }, - "454": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "qualifiedName": "model" - }, - "455": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "qualifiedName": "options" - }, - "456": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "qualifiedName": "__type" - }, - "457": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.sources.ts", - "qualifiedName": "__type.headingLevel" - }, - "458": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "qualifiedName": "member" - }, - "459": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "qualifiedName": "member" - }, - "460": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "qualifiedName": "this" - }, - "461": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "qualifiedName": "model" - }, - "462": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "qualifiedName": "options" - }, - "463": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "qualifiedName": "__type" - }, - "464": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "qualifiedName": "__type.headingLevel" - }, - "465": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.ts", - "qualifiedName": "__type.nested" - }, - "466": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts", - "qualifiedName": "typeAndParent" - }, - "467": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts", - "qualifiedName": "typeAndParent" - }, - "468": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts", - "qualifiedName": "this" - }, - "469": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeAndParent.ts", - "qualifiedName": "model" - }, - "470": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "qualifiedName": "typeArguments" - }, - "471": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "qualifiedName": "typeArguments" - }, - "472": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "qualifiedName": "this" - }, - "473": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "qualifiedName": "model" - }, - "474": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "qualifiedName": "options" - }, - "475": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "qualifiedName": "__type" - }, - "476": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeArguments.ts", - "qualifiedName": "__type.foreCollpase" - }, - "477": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "qualifiedName": "typeDeclaration" - }, - "478": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "qualifiedName": "typeDeclaration" - }, - "479": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "qualifiedName": "this" - }, - "480": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "qualifiedName": "model" - }, - "481": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "qualifiedName": "options" - }, - "482": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "qualifiedName": "__type" - }, - "483": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclaration.ts", - "qualifiedName": "__type.headingLevel" - }, - "484": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts", - "qualifiedName": "typeDeclarationList" - }, - "485": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts", - "qualifiedName": "typeDeclarationList" - }, - "486": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts", - "qualifiedName": "this" - }, - "487": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts", - "qualifiedName": "model" - }, - "488": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationList.ts", - "qualifiedName": "headingLevel" - }, - "489": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts", - "qualifiedName": "typeDeclarationTable" - }, - "490": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts", - "qualifiedName": "typeDeclarationTable" - }, - "491": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts", - "qualifiedName": "this" - }, - "492": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts", - "qualifiedName": "model" - }, - "493": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts", - "qualifiedName": "typeParametersList" - }, - "494": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts", - "qualifiedName": "typeParametersList" - }, - "495": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts", - "qualifiedName": "this" - }, - "496": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts", - "qualifiedName": "model" - }, - "497": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts", - "qualifiedName": "typeParametersTable" - }, - "498": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts", - "qualifiedName": "typeParametersTable" - }, - "499": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts", - "qualifiedName": "this" - }, - "500": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersTable.ts", - "qualifiedName": "model" - }, - "501": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts", - "qualifiedName": "breadcrumbs" - }, - "502": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts", - "qualifiedName": "breadcrumbs" - }, - "503": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts", - "qualifiedName": "this" - }, - "504": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts", - "qualifiedName": "footer" - }, - "505": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts", - "qualifiedName": "footer" - }, - "506": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.footer.ts", - "qualifiedName": "this" - }, - "507": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts", - "qualifiedName": "header" - }, - "508": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts", - "qualifiedName": "header" - }, - "509": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts", - "qualifiedName": "this" - }, - "510": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts", - "qualifiedName": "packagesIndex" - }, - "511": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts", - "qualifiedName": "packagesIndex" - }, - "512": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts", - "qualifiedName": "this" - }, - "513": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.packagesIndex.ts", - "qualifiedName": "model" - }, - "514": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts", - "qualifiedName": "pageTitle" - }, - "515": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts", - "qualifiedName": "pageTitle" - }, - "516": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts", - "qualifiedName": "this" - }, - "517": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts", - "qualifiedName": "arrayType" - }, - "518": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts", - "qualifiedName": "arrayType" - }, - "519": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts", - "qualifiedName": "this" - }, - "520": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.array.ts", - "qualifiedName": "model" - }, - "521": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts", - "qualifiedName": "conditionalType" - }, - "522": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts", - "qualifiedName": "conditionalType" - }, - "523": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts", - "qualifiedName": "this" - }, - "524": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.conditional.ts", - "qualifiedName": "model" - }, - "525": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts", - "qualifiedName": "indexAccessType" - }, - "526": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts", - "qualifiedName": "indexAccessType" - }, - "527": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts", - "qualifiedName": "this" - }, - "528": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.index-access.ts", - "qualifiedName": "model" - }, - "529": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts", - "qualifiedName": "inferredType" - }, - "530": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts", - "qualifiedName": "inferredType" - }, - "531": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts", - "qualifiedName": "this" - }, - "532": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.inferred.ts", - "qualifiedName": "model" - }, - "533": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts", - "qualifiedName": "intersectionType" - }, - "534": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts", - "qualifiedName": "intersectionType" - }, - "535": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts", - "qualifiedName": "this" - }, - "536": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intersection.ts", - "qualifiedName": "model" - }, - "537": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts", - "qualifiedName": "intrinsicType" - }, - "538": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts", - "qualifiedName": "intrinsicType" - }, - "539": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts", - "qualifiedName": "this" - }, - "540": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.intrinsic.ts", - "qualifiedName": "model" - }, - "541": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts", - "qualifiedName": "literalType" - }, - "542": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts", - "qualifiedName": "literalType" - }, - "543": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts", - "qualifiedName": "this" - }, - "544": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.literal.ts", - "qualifiedName": "model" - }, - "545": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts", - "qualifiedName": "namedTupleType" - }, - "546": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts", - "qualifiedName": "namedTupleType" - }, - "547": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts", - "qualifiedName": "this" - }, - "548": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.named-tuple.ts", - "qualifiedName": "model" - }, - "549": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts", - "qualifiedName": "queryType" - }, - "550": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts", - "qualifiedName": "queryType" - }, - "551": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts", - "qualifiedName": "this" - }, - "552": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.query.ts", - "qualifiedName": "model" - }, - "553": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts", - "qualifiedName": "referenceType" - }, - "554": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts", - "qualifiedName": "referenceType" - }, - "555": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts", - "qualifiedName": "this" - }, - "556": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reference.ts", - "qualifiedName": "model" - }, - "557": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts", - "qualifiedName": "declarationType" - }, - "558": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts", - "qualifiedName": "declarationType" - }, - "559": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts", - "qualifiedName": "this" - }, - "560": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.declaration.ts", - "qualifiedName": "model" - }, - "561": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "qualifiedName": "functionType" - }, - "562": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "qualifiedName": "functionType" - }, - "563": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "qualifiedName": "this" - }, - "564": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "qualifiedName": "model" - }, - "565": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "qualifiedName": "options" - }, - "566": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "qualifiedName": "__type" - }, - "567": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.function.ts", - "qualifiedName": "__type.forceParameterType" - }, - "568": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "qualifiedName": "reflectionType" - }, - "569": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "qualifiedName": "reflectionType" - }, - "570": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "qualifiedName": "this" - }, - "571": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "qualifiedName": "model" - }, - "572": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "qualifiedName": "options" - }, - "573": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "qualifiedName": "__type" - }, - "574": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.reflection.ts", - "qualifiedName": "__type.foreCollpase" - }, - "575": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts", - "qualifiedName": "someType" - }, - "576": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts", - "qualifiedName": "someType" - }, - "577": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts", - "qualifiedName": "this" - }, - "578": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.some.ts", - "qualifiedName": "model" - }, - "579": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts", - "qualifiedName": "tupleType" - }, - "580": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts", - "qualifiedName": "tupleType" - }, - "581": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts", - "qualifiedName": "this" - }, - "582": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.tuple.ts", - "qualifiedName": "model" - }, - "583": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts", - "qualifiedName": "typeOperatorType" - }, - "584": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts", - "qualifiedName": "typeOperatorType" - }, - "585": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts", - "qualifiedName": "this" - }, - "586": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.type-operator.ts", - "qualifiedName": "model" - }, - "587": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts", - "qualifiedName": "unionType" - }, - "588": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts", - "qualifiedName": "unionType" - }, - "589": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts", - "qualifiedName": "this" - }, - "590": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.union.ts", - "qualifiedName": "model" - }, - "591": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts", - "qualifiedName": "unknownType" - }, - "592": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts", - "qualifiedName": "unknownType" - }, - "593": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts", - "qualifiedName": "this" - }, - "594": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/partials/type.unknown.ts", - "qualifiedName": "model" - }, - "595": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/index.ts", - "qualifiedName": "" - }, - "596": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts", - "qualifiedName": "document" - }, - "597": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts", - "qualifiedName": "document" - }, - "598": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts", - "qualifiedName": "this" - }, - "599": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts", - "qualifiedName": "page" - }, - "600": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts", - "qualifiedName": "project" - }, - "601": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts", - "qualifiedName": "project" - }, - "602": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts", - "qualifiedName": "this" - }, - "603": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts", - "qualifiedName": "page" - }, - "604": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts", - "qualifiedName": "readme" - }, - "605": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts", - "qualifiedName": "readme" - }, - "606": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts", - "qualifiedName": "this" - }, - "607": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts", - "qualifiedName": "page" - }, - "608": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts", - "qualifiedName": "reflection" - }, - "609": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts", - "qualifiedName": "reflection" - }, - "610": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts", - "qualifiedName": "this" - }, - "611": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts", - "qualifiedName": "page" - }, - "612": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/index.ts", - "qualifiedName": "" - }, - "613": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "NavigationBuilder" - }, - "614": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "NavigationBuilder.__constructor" - }, - "615": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "NavigationBuilder" - }, - "616": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "theme" - }, - "617": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "project" - }, - "618": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "NavigationBuilder.theme" - }, - "619": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "NavigationBuilder.project" - }, - "620": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "NavigationBuilder.getNavigation" - }, - "621": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts", - "qualifiedName": "NavigationBuilder.getNavigation" - }, - "622": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder" - }, - "623": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder.__constructor" - }, - "624": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder" - }, - "625": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "theme" - }, - "626": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "project" - }, - "627": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder.theme" - }, - "628": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder.project" - }, - "629": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder.getUrls" - }, - "630": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder.getUrls" - }, - "631": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder.getFlattenedUrl" - }, - "632": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "UrlBuilder.getFlattenedUrl" - }, - "633": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts", - "qualifiedName": "reflection" - }, - "634": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext" - }, - "635": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.internationalization" - }, - "636": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.i18n" - }, - "637": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.__constructor" - }, - "638": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext" - }, - "639": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "theme" - }, - "640": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "page" - }, - "641": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "options" - }, - "642": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.page" - }, - "643": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.options" - }, - "644": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.templates" - }, - "645": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/resources.ts", - "qualifiedName": "__object" - }, - "646": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.partials" - }, - "647": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/resources.ts", - "qualifiedName": "__object" - }, - "648": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.helpers" - }, - "649": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/context/resources.ts", - "qualifiedName": "__object" - }, - "650": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.getPackageMetaData" - }, - "651": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.getPackageMetaData" - }, - "652": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "packageName" - }, - "653": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.getRelativeUrl" - }, - "654": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.getRelativeUrl" - }, - "655": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "url" - }, - "656": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "ignorePublicPath" - }, - "657": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.hook" - }, - "658": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "MarkdownThemeContext.hook" - }, - "659": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts", - "qualifiedName": "name" - }, - "660": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme" - }, - "661": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/component.d.ts", - "qualifiedName": "AbstractComponent.__constructor" - }, - "662": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/component.d.ts", - "qualifiedName": "MarkdownTheme" - }, - "663": { - "sourceFileName": "node_modules/typedoc/dist/lib/utils/component.d.ts", - "qualifiedName": "owner" - }, - "664": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.render" - }, - "665": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.render" - }, - "666": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "page" - }, - "667": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "template" - }, - "668": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.getRenderContext" - }, - "669": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.getRenderContext" - }, - "670": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "page" - }, - "671": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.getUrls" - }, - "672": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.getUrls" - }, - "673": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "project" - }, - "674": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.getNavigation" - }, - "675": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.getNavigation" - }, - "676": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "project" - }, - "677": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.getTemplateMapping" - }, - "678": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.getTemplateMapping" - }, - "679": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "kind" - }, - "680": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "outputFileStrategy" - }, - "681": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.documentTemplate" - }, - "682": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.documentTemplate" - }, - "683": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "page" - }, - "684": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.readmeTemplate" - }, - "685": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.readmeTemplate" - }, - "686": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "page" - }, - "687": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.projectTemplate" - }, - "688": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.projectTemplate" - }, - "689": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "page" - }, - "690": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.reflectionTemplate" - }, - "691": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "MarkdownTheme.reflectionTemplate" - }, - "692": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts", - "qualifiedName": "page" - }, - "693": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "" - }, - "694": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "PackageMetaData" - }, - "695": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "PackageMetaData.description" - }, - "696": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "PackageMetaData.options" - }, - "697": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlMapping" - }, - "698": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlMapping.url" - }, - "699": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlMapping.model" - }, - "700": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlMapping.template" - }, - "701": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "__type" - }, - "702": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "__type" - }, - "703": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "data" - }, - "704": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlMapping.Model" - }, - "705": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "NavigationItem" - }, - "706": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "NavigationItem.title" - }, - "707": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "NavigationItem.path" - }, - "708": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "NavigationItem.kind" - }, - "709": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "NavigationItem.children" - }, - "710": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "RenderTemplate" - }, - "711": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "T" - }, - "712": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "__type" - }, - "713": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "__type" - }, - "714": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "data" - }, - "715": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "TemplateMapping" - }, - "716": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "TemplateMapping.directory" - }, - "717": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "TemplateMapping.template" - }, - "718": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "TemplateMapping.kind" - }, - "719": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlOption" - }, - "720": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlOption.parentUrl" - }, - "721": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlOption.directory" - }, - "722": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlOption.forceDirectory" - }, - "723": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlOption.outputFileStrategy" - }, - "724": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlOption.entryModule" - }, - "725": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "qualifiedName": "UrlOption.entryFileName" - }, - "726": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/index.ts", - "qualifiedName": "" - }, - "727": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/index.ts", - "qualifiedName": "" - }, - "728": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts", - "qualifiedName": "backTicks" - }, - "729": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts", - "qualifiedName": "backTicks" - }, - "730": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts", - "qualifiedName": "text" - }, - "731": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts", - "qualifiedName": "blockQuoteBlock" - }, - "732": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts", - "qualifiedName": "blockQuoteBlock" - }, - "733": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts", - "qualifiedName": "content" - }, - "734": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts", - "qualifiedName": "bold" - }, - "735": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts", - "qualifiedName": "bold" - }, - "736": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts", - "qualifiedName": "text" - }, - "737": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts", - "qualifiedName": "codeBlock" - }, - "738": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts", - "qualifiedName": "codeBlock" - }, - "739": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts", - "qualifiedName": "content" - }, - "740": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts", - "qualifiedName": "heading" - }, - "741": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts", - "qualifiedName": "heading" - }, - "742": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts", - "qualifiedName": "level" - }, - "743": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts", - "qualifiedName": "text" - }, - "744": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts", - "qualifiedName": "horizontalRule" - }, - "745": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts", - "qualifiedName": "horizontalRule" - }, - "746": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts", - "qualifiedName": "htmlTable" - }, - "747": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts", - "qualifiedName": "htmlTable" - }, - "748": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts", - "qualifiedName": "headers" - }, - "749": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts", - "qualifiedName": "rows" - }, - "750": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts", - "qualifiedName": "leftAlignHeadings" - }, - "751": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts", - "qualifiedName": "indentBlock" - }, - "752": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts", - "qualifiedName": "indentBlock" - }, - "753": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts", - "qualifiedName": "content" - }, - "754": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts", - "qualifiedName": "italic" - }, - "755": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts", - "qualifiedName": "italic" - }, - "756": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts", - "qualifiedName": "text" - }, - "757": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/link.ts", - "qualifiedName": "link" - }, - "758": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/link.ts", - "qualifiedName": "link" - }, - "759": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/link.ts", - "qualifiedName": "label" - }, - "760": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/link.ts", - "qualifiedName": "url" - }, - "761": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts", - "qualifiedName": "strikeThrough" - }, - "762": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts", - "qualifiedName": "strikeThrough" - }, - "763": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts", - "qualifiedName": "content" - }, - "764": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/table.ts", - "qualifiedName": "table" - }, - "765": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/table.ts", - "qualifiedName": "table" - }, - "766": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/table.ts", - "qualifiedName": "headers" - }, - "767": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/table.ts", - "qualifiedName": "rows" - }, - "768": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/table.ts", - "qualifiedName": "headerLeftAlign" - }, - "769": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts", - "qualifiedName": "unorderedList" - }, - "770": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts", - "qualifiedName": "unorderedList" - }, - "771": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts", - "qualifiedName": "items" - }, - "772": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/index.ts", - "qualifiedName": "" - }, - "773": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts", - "qualifiedName": "camelToTitleCase" - }, - "774": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts", - "qualifiedName": "camelToTitleCase" - }, - "775": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts", - "qualifiedName": "text" - }, - "776": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts", - "qualifiedName": "escapeChars" - }, - "777": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts", - "qualifiedName": "escapeChars" - }, - "778": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts", - "qualifiedName": "str" - }, - "779": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts", - "qualifiedName": "formatMarkdown" - }, - "780": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts", - "qualifiedName": "formatMarkdown" - }, - "781": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts", - "qualifiedName": "str" - }, - "782": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts", - "qualifiedName": "formatTableCell" - }, - "783": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts", - "qualifiedName": "formatTableCell" - }, - "784": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts", - "qualifiedName": "str" - }, - "785": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts", - "qualifiedName": "getFileNameWithExtension" - }, - "786": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts", - "qualifiedName": "getFileNameWithExtension" - }, - "787": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts", - "qualifiedName": "fileName" - }, - "788": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts", - "qualifiedName": "fileExtension" - }, - "789": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts", - "qualifiedName": "isQuoted" - }, - "790": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts", - "qualifiedName": "isQuoted" - }, - "791": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts", - "qualifiedName": "str" - }, - "792": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts", - "qualifiedName": "normalizeLineBreaks" - }, - "793": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts", - "qualifiedName": "normalizeLineBreaks" - }, - "794": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts", - "qualifiedName": "str" - }, - "795": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts", - "qualifiedName": "removeFirstScopedDirectory" - }, - "796": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts", - "qualifiedName": "removeFirstScopedDirectory" - }, - "797": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts", - "qualifiedName": "urlString" - }, - "798": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts", - "qualifiedName": "removeLineBreaks" - }, - "799": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts", - "qualifiedName": "removeLineBreaks" - }, - "800": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts", - "qualifiedName": "str" - }, - "801": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts", - "qualifiedName": "sanitizeComments" - }, - "802": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts", - "qualifiedName": "sanitizeComments" - }, - "803": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts", - "qualifiedName": "str" - }, - "804": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts", - "qualifiedName": "slugify" - }, - "805": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts", - "qualifiedName": "slugify" - }, - "806": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts", - "qualifiedName": "url" - }, - "807": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts", - "qualifiedName": "toPascalCase" - }, - "808": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts", - "qualifiedName": "toPascalCase" - }, - "809": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts", - "qualifiedName": "text" - }, - "810": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts", - "qualifiedName": "unEscapeChars" - }, - "811": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts", - "qualifiedName": "unEscapeChars" - }, - "812": { - "sourceFileName": "packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts", - "qualifiedName": "str" - }, - "814": { - "sourceFileName": "packages/typedoc-plugin-frontmatter/src/index.ts", - "qualifiedName": "" - }, - "815": { - "sourceFileName": "packages/typedoc-plugin-frontmatter/src/index.ts", - "qualifiedName": "load" - }, - "816": { - "sourceFileName": "packages/typedoc-plugin-frontmatter/src/index.ts", - "qualifiedName": "load" - }, - "817": { - "sourceFileName": "packages/typedoc-plugin-frontmatter/src/index.ts", - "qualifiedName": "app" - } - }, - "files": { - "entries": { - "1": "TEST.md", - "2": "packages/typedoc-plugin-markdown/src/app/index.ts", - "3": "packages/typedoc-plugin-markdown/src/options/index.ts", - "4": "packages/typedoc-plugin-markdown/src/internationalization/index.ts", - "5": "packages/typedoc-plugin-markdown/src/theme/index.ts", - "6": "packages/typedoc-plugin-markdown/src/libs/index.ts", - "7": "packages/typedoc-plugin-markdown/src/app/_initialize.ts", - "8": "packages/typedoc-plugin-markdown/src/app/events/index.ts", - "9": "packages/typedoc-plugin-markdown/src/app/renderer.ts", - "10": "packages/typedoc-plugin-markdown/src/app/types/index.ts", - "11": "packages/typedoc-plugin-markdown/src/options/constants.ts", - "12": "packages/typedoc-plugin-markdown/src/options/declarations.ts", - "13": "packages/typedoc-plugin-markdown/src/options/maps.ts", - "14": "packages/typedoc-plugin-markdown/src/options/types.ts", - "15": "packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts", - "16": "packages/typedoc-plugin-markdown/src/internationalization/translatable.ts", - "17": "packages/typedoc-plugin-markdown/src/internationalization/types.ts", - "18": "packages/typedoc-plugin-markdown/src/theme/context/index.ts", - "19": "packages/typedoc-plugin-markdown/src/theme/context/helpers/index.ts", - "20": "packages/typedoc-plugin-markdown/src/theme/context/partials/index.ts", - "21": "packages/typedoc-plugin-markdown/src/theme/context/templates/index.ts", - "22": "packages/typedoc-plugin-markdown/src/theme/core/index.ts", - "23": "packages/typedoc-plugin-markdown/src/theme/types.ts", - "24": "packages/typedoc-plugin-markdown/src/libs/markdown/index.ts", - "25": "packages/typedoc-plugin-markdown/src/libs/utils/index.ts", - "26": "packages/typedoc-plugin-frontmatter/src/index.ts" - }, - "reflections": { - "1": 1, - "2": 2, - "3": 3, - "4": 4, - "5": 5, - "6": 6, - "7": 7, - "8": 11, - "9": 44, - "10": 58, - "11": 89, - "12": 99, - "13": 129, - "14": 140, - "15": 190, - "16": 193, - "17": 197, - "18": 213, - "19": 214, - "20": 285, - "21": 612, - "22": 629, - "23": 752, - "24": 1261, - "25": 1306, - "26": 0 - } - } -} \ No newline at end of file diff --git a/developer-docs/typedoc-plugin-frontmatter/app/namespaces/initialize/README.md b/developer-docs/typedoc-plugin-frontmatter/app/namespaces/initialize/README.md index d474e562..e98a5d2c 100644 --- a/developer-docs/typedoc-plugin-frontmatter/app/namespaces/initialize/README.md +++ b/developer-docs/typedoc-plugin-frontmatter/app/namespaces/initialize/README.md @@ -18,4 +18,4 @@ ### Defined in -[app/initialize.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/app/initialize.ts#L13) +[app/initialize.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/app/initialize.ts#L13) diff --git a/developer-docs/typedoc-plugin-frontmatter/app/namespaces/tags/README.md b/developer-docs/typedoc-plugin-frontmatter/app/namespaces/tags/README.md index 5b65ae86..be2b7717 100644 --- a/developer-docs/typedoc-plugin-frontmatter/app/namespaces/tags/README.md +++ b/developer-docs/typedoc-plugin-frontmatter/app/namespaces/tags/README.md @@ -24,7 +24,7 @@ ### Defined in -[app/tags.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L4) +[app/tags.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L4) *** @@ -46,4 +46,4 @@ ### Defined in -[app/tags.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L28) +[app/tags.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L28) diff --git a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md b/developer-docs/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md index 4b9b9e5b..11409455 100644 --- a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md +++ b/developer-docs/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md @@ -40,7 +40,7 @@ sidebar: true ### Defined in -[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15) +[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15) *** @@ -66,7 +66,7 @@ sidebar: true ### Defined in -[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24) +[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24) *** @@ -92,7 +92,7 @@ sidebar: true ### Defined in -[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33) +[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33) *** @@ -136,7 +136,7 @@ description: A description that will be added to frontmatter. ### Defined in -[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61) +[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61) *** @@ -156,7 +156,7 @@ description: A description that will be added to frontmatter. ### Defined in -[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66) +[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66) *** @@ -181,4 +181,4 @@ This option can configure the output style of frontmatter variables when written ### Defined in -[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77) +[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77) diff --git a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/types/interfaces/PluginOptions.md b/developer-docs/typedoc-plugin-frontmatter/options/namespaces/types/interfaces/PluginOptions.md index 22ca0d31..3176defe 100644 --- a/developer-docs/typedoc-plugin-frontmatter/options/namespaces/types/interfaces/PluginOptions.md +++ b/developer-docs/typedoc-plugin-frontmatter/options/namespaces/types/interfaces/PluginOptions.md @@ -6,72 +6,11 @@ Describes the options declared by the plugin. ## Properties -### frontmatterCommentTags - -> **frontmatterCommentTags**: `any`\[] - -Specify which comment block tags should be added to frontmatter. - -#### Defined in - -[options/types.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L16) - -*** - -### frontmatterGlobals - -> **frontmatterGlobals**: [`FrontmatterGlobals`](FrontmatterGlobals.md) - -Specify static variables to be added to all frontmatter blocks. - -#### Defined in - -[options/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L21) - -*** - -### frontmatterNamingConvention - -> **frontmatterNamingConvention**: `"camelCase"` | `"snakeCase"` - -The naming convention that variables should be output as. - -#### Defined in - -[options/types.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L26) - -*** - -### indexFrontmatter - -> **indexFrontmatter**: [`IndexFrontmatter`](IndexFrontmatter.md) - -Specify static variables to be added to the index page only. - -#### Defined in - -[options/types.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L31) - -*** - -### preserveFrontmatterCommentTags - -> **preserveFrontmatterCommentTags**: `boolean` - -Preserve tags defined in frontmatter block tags in output. - -#### Defined in - -[options/types.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L36) - -*** - -### readmeFrontmatter - -> **readmeFrontmatter**: [`ReadmeFrontmatter`](ReadmeFrontmatter.md) - -Specify static variables to be added to the readme page only. - -#### Defined in - -[options/types.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L41) +| Property | Type | Description | +| -------------------------------- | --------------------------------------------- | ---------------------------------------------------------------- | +| `frontmatterCommentTags` | `any`\[] | Specify which comment block tags should be added to frontmatter. | +| `frontmatterGlobals` | [`FrontmatterGlobals`](FrontmatterGlobals.md) | Specify static variables to be added to all frontmatter blocks. | +| `frontmatterNamingConvention` | `"camelCase"` \| `"snakeCase"` | The naming convention that variables should be output as. | +| `indexFrontmatter` | [`IndexFrontmatter`](IndexFrontmatter.md) | Specify static variables to be added to the index page only. | +| `preserveFrontmatterCommentTags` | `boolean` | Preserve tags defined in frontmatter block tags in output. | +| `readmeFrontmatter` | [`ReadmeFrontmatter`](ReadmeFrontmatter.md) | Specify static variables to be added to the readme page only. | diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownPageEvent.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownPageEvent.md index bdb9f287..49d0d328 100644 --- a/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownPageEvent.md +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownPageEvent.md @@ -17,14 +17,16 @@ An event emitted by before and after the markup of a page is rendered. * [frontmatter?](#frontmatter) * [Accessors](#accessors) * [name](#name) + * [Inherited from](#inherited-from) * [isPropagationStopped](#ispropagationstopped) + * [Inherited from](#inherited-from-1) * [Methods](#methods) * [stopPropagation()](#stoppropagation) - * [Inherited from](#inherited-from) + * [Inherited from](#inherited-from-2) * [preventDefault()](#preventdefault) - * [Inherited from](#inherited-from-1) + * [Inherited from](#inherited-from-3) * [isDefaultPrevented()](#isdefaultprevented) - * [Inherited from](#inherited-from-2) + * [Inherited from](#inherited-from-4) * [Events](#events) * [BEGIN](#begin) * [END](#end) @@ -59,7 +61,7 @@ The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflecti #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L22) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L22) *** @@ -72,7 +74,7 @@ Either a [`DeclarationReflection`](https://typedoc.org/api/classes/Models.Declar #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L28) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L28) *** @@ -86,7 +88,7 @@ Should be rendered by layout templates and can be modified by plugins. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L35) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L35) *** @@ -98,7 +100,7 @@ The url `string` of the page. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L40) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L40) *** @@ -110,7 +112,7 @@ The complete `string` filename where the file will be written.. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L45) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L45) *** @@ -122,7 +124,7 @@ The frontmatter of this page represented as a key value object. This property ca #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L50) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L50) ## Accessors @@ -136,6 +138,10 @@ Return the event name. `string` +#### Inherited from + +`Event.name` + #### Defined in node\_modules/typedoc/dist/lib/utils/events.d.ts:38 @@ -152,6 +158,10 @@ Has [Event.stopPropagation](MarkdownPageEvent.md#stoppropagation) been called? `boolean` +#### Inherited from + +`Event.isPropagationStopped` + #### Defined in node\_modules/typedoc/dist/lib/utils/events.d.ts:42 @@ -226,7 +236,7 @@ Triggered before a document will be rendered. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L62) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L62) *** @@ -238,4 +248,4 @@ Triggered after a document has been rendered, just before it is written to disc. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L68) +[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L68) diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownRendererEvent.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownRendererEvent.md index dbcab4b2..597efd0b 100644 --- a/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownRendererEvent.md +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownRendererEvent.md @@ -14,14 +14,16 @@ An event emitted at the beginning and end of the rendering process. * [navigation?](#navigation) * [Accessors](#accessors) * [name](#name) + * [Inherited from](#inherited-from) * [isPropagationStopped](#ispropagationstopped) + * [Inherited from](#inherited-from-1) * [Methods](#methods) * [stopPropagation()](#stoppropagation) - * [Inherited from](#inherited-from) + * [Inherited from](#inherited-from-2) * [preventDefault()](#preventdefault) - * [Inherited from](#inherited-from-1) + * [Inherited from](#inherited-from-3) * [isDefaultPrevented()](#isdefaultprevented) - * [Inherited from](#inherited-from-2) + * [Inherited from](#inherited-from-4) * [Events](#events) * [BEGIN](#begin) * [END](#end) @@ -48,7 +50,7 @@ The project the renderer is currently processing. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L21) +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L21) *** @@ -60,7 +62,7 @@ The path of the directory the documentation should be written to. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L26) +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L26) *** @@ -72,7 +74,7 @@ A list of all pages that should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L31) +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L31) *** @@ -84,7 +86,7 @@ The navigation structure of the project that can be utilised by plugins. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L36) +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L36) ## Accessors @@ -98,6 +100,10 @@ Return the event name. `string` +#### Inherited from + +`Event.name` + #### Defined in node\_modules/typedoc/dist/lib/utils/events.d.ts:38 @@ -114,6 +120,10 @@ Has [Event.stopPropagation](MarkdownPageEvent.md#stoppropagation) been called? `boolean` +#### Inherited from + +`Event.isPropagationStopped` + #### Defined in node\_modules/typedoc/dist/lib/utils/events.d.ts:42 @@ -188,7 +198,7 @@ Triggered before the renderer starts rendering a project. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L42) +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L42) *** @@ -200,4 +210,4 @@ Triggered after the renderer has written all documents. #### Defined in -[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L48) +[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L48) diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/initialize/README.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/initialize/README.md index 036e36b6..f559e068 100644 --- a/developer-docs/typedoc-plugin-markdown/app/namespaces/initialize/README.md +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/initialize/README.md @@ -35,4 +35,4 @@ In summary this method: ### Defined in -[packages/typedoc-plugin-markdown/src/app/\_initialize.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L38) +[packages/typedoc-plugin-markdown/src/app/\_initialize.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L38) diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/renderer/README.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/renderer/README.md index b740294e..ba272984 100644 --- a/developer-docs/typedoc-plugin-markdown/app/namespaces/renderer/README.md +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/renderer/README.md @@ -29,7 +29,7 @@ Replacement of TypeDoc's [Application.generateDocs](../types/interfaces/Markdown ### Defined in -[packages/typedoc-plugin-markdown/src/app/renderer.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/renderer.ts#L26) +[packages/typedoc-plugin-markdown/src/app/renderer.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/renderer.ts#L26) *** @@ -58,7 +58,7 @@ This is essentially a copy of the base method with a few tweaks. ### Defined in -[packages/typedoc-plugin-markdown/src/app/renderer.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/renderer.ts#L48) +[packages/typedoc-plugin-markdown/src/app/renderer.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/renderer.ts#L48) *** @@ -84,4 +84,4 @@ By intercepting the package options set in the converter and storing them on the ### Defined in -[packages/typedoc-plugin-markdown/src/app/renderer.ts:145](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/renderer.ts#L145) +[packages/typedoc-plugin-markdown/src/app/renderer.ts:145](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/renderer.ts#L145) diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownApplication.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownApplication.md index 6bf407d0..b4c907a7 100644 --- a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownApplication.md +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownApplication.md @@ -8,70 +8,57 @@ This interface is essentially an extended typing of TypeDoc's [`Application`](ht * [Extends](#extends) * [Properties](#properties) - * [converter](#converter) - * [Inherited from](#inherited-from) - * [serializer](#serializer) - * [Inherited from](#inherited-from-1) - * [deserializer](#deserializer) - * [Inherited from](#inherited-from-2) - * [logger](#logger) - * [Inherited from](#inherited-from-3) - * [internationalization](#internationalization) - * [Inherited from](#inherited-from-4) - * [i18n](#i18n) - * [Inherited from](#inherited-from-5) - * [options](#options) - * [Inherited from](#inherited-from-6) - * [files](#files) - * [Inherited from](#inherited-from-7) - * [componentName](#componentname) - * [Inherited from](#inherited-from-8) - * [renderer](#renderer) - * [Overrides](#overrides) * [Accessors](#accessors) * [lang](#lang) + * [Inherited from](#inherited-from) * [skipErrorChecking](#skiperrorchecking) + * [Inherited from](#inherited-from-1) * [entryPointStrategy](#entrypointstrategy) + * [Inherited from](#inherited-from-2) * [entryPoints](#entrypoints) + * [Inherited from](#inherited-from-3) * [application](#application) + * [Inherited from](#inherited-from-4) * [owner](#owner) + * [Inherited from](#inherited-from-5) * [\_listenId](#_listenid) + * [Inherited from](#inherited-from-6) * [Methods](#methods) * [getTypeScriptPath()](#gettypescriptpath) - * [Inherited from](#inherited-from-9) + * [Inherited from](#inherited-from-7) * [getTypeScriptVersion()](#gettypescriptversion) - * [Inherited from](#inherited-from-10) + * [Inherited from](#inherited-from-8) * [getEntryPoints()](#getentrypoints) - * [Inherited from](#inherited-from-11) + * [Inherited from](#inherited-from-9) * [convert()](#convert) - * [Inherited from](#inherited-from-12) + * [Inherited from](#inherited-from-10) * [convertAndWatch()](#convertandwatch) - * [Inherited from](#inherited-from-13) + * [Inherited from](#inherited-from-11) * [validate()](#validate) - * [Inherited from](#inherited-from-14) + * [Inherited from](#inherited-from-12) * [generateDocs()](#generatedocs) - * [Inherited from](#inherited-from-15) + * [Inherited from](#inherited-from-13) * [generateJson()](#generatejson) - * [Inherited from](#inherited-from-16) + * [Inherited from](#inherited-from-14) * [toString()](#tostring) - * [Inherited from](#inherited-from-17) + * [Inherited from](#inherited-from-15) * [initialize()](#initialize) - * [Inherited from](#inherited-from-18) + * [Inherited from](#inherited-from-16) * [bubble()](#bubble) - * [Inherited from](#inherited-from-19) + * [Inherited from](#inherited-from-17) * [getComponent()](#getcomponent) - * [Inherited from](#inherited-from-20) + * [Inherited from](#inherited-from-18) * [getComponents()](#getcomponents) - * [Inherited from](#inherited-from-21) + * [Inherited from](#inherited-from-19) * [hasComponent()](#hascomponent) - * [Inherited from](#inherited-from-22) + * [Inherited from](#inherited-from-20) * [addComponent()](#addcomponent) * [Type Parameters](#type-parameters) - * [Inherited from](#inherited-from-23) + * [Inherited from](#inherited-from-21) * [removeComponent()](#removecomponent) - * [Inherited from](#inherited-from-24) + * [Inherited from](#inherited-from-22) * [removeAllComponents()](#removeallcomponents) - * [Inherited from](#inherited-from-25) + * [Inherited from](#inherited-from-23) * [on()](#on) * [on(eventMap, context)](#oneventmap-context) * [on(eventMap, callback, context, priority)](#oneventmap-callback-context-priority) @@ -84,14 +71,14 @@ This interface is essentially an extended typing of TypeDoc's [`Application`](ht * [off(eventMap, context)](#offeventmap-context) * [off(name, callback, context)](#offname-callback-context) * [listenTo()](#listento) - * [Inherited from](#inherited-from-34) + * [Inherited from](#inherited-from-32) * [listenToOnce()](#listentoonce) * [listenToOnce(obj, eventMap)](#listentoonceobj-eventmap) * [listenToOnce(obj, name, callback, priority)](#listentoonceobj-name-callback-priority) * [stopListening()](#stoplistening) - * [Inherited from](#inherited-from-37) + * [Inherited from](#inherited-from-35) * [trigger()](#trigger) - * [Inherited from](#inherited-from-38) + * [Inherited from](#inherited-from-36) ## Example @@ -109,176 +96,66 @@ export function load(app: MarkdownApplication) { ## Properties -### converter - -> **converter**: `Converter` - -The converter used to create the declaration reflections. - -#### Inherited from - -`Application.converter` - -#### Defined in - -node\_modules/typedoc/dist/lib/application.d.ts:35 - -*** - -### serializer - -> **serializer**: `Serializer` - -The serializer used to generate JSON output. - -#### Inherited from - -`Application.serializer` - -#### Defined in - -node\_modules/typedoc/dist/lib/application.d.ts:43 - -*** - -### deserializer - -> **deserializer**: `Deserializer` - -The deserializer used to restore previously serialized JSON output. - -#### Inherited from +| Property | Type | Description | Overrides | Inherited from | +| ---------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------- | ---------------------------------- | +| `converter` | `Converter` | The converter used to create the declaration reflections. | - | `Application.converter` | +| `serializer` | `Serializer` | The serializer used to generate JSON output. | - | `Application.serializer` | +| `deserializer` | `Deserializer` | The deserializer used to restore previously serialized JSON output. | - | `Application.deserializer` | +| `logger` | `Logger` | The logger that should be used to output messages. | - | `Application.logger` | +| `internationalization` | `Internationalization` | Internationalization module which supports translating according to the `lang` option. | - | `Application.internationalization` | +| `i18n` | `TranslationProxy` | Proxy based shortcuts for internationalization keys. | - | `Application.i18n` | +| `options` | [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) | - | - | `Application.options` | +| `files` | `FileRegistry` | - | - | `Application.files` | +| `componentName` | `string` | The name of this component as set by the `@Component` decorator. | - | `Application.componentName` | +| `renderer` | [`MarkdownRenderer`](MarkdownRenderer.md) | Re-types the `renderer` instance to [`MarkdownRenderer`](MarkdownRenderer.md). | `Application.renderer` | - | -`Application.deserializer` - -#### Defined in - -node\_modules/typedoc/dist/lib/application.d.ts:47 - -*** - -### logger - -> **logger**: `Logger` - -The logger that should be used to output messages. - -#### Inherited from - -`Application.logger` - -#### Defined in - -node\_modules/typedoc/dist/lib/application.d.ts:51 - -*** - -### internationalization - -> **internationalization**: `Internationalization` - -Internationalization module which supports translating according to -the `lang` option. - -#### Inherited from - -`Application.internationalization` - -#### Defined in - -node\_modules/typedoc/dist/lib/application.d.ts:56 - -*** - -### i18n - -> **i18n**: `TranslationProxy` +## Accessors -Proxy based shortcuts for internationalization keys. +### lang #### Inherited from -`Application.i18n` +`Application.lang` #### Defined in -node\_modules/typedoc/dist/lib/application.d.ts:60 +node\_modules/typedoc/dist/lib/application.d.ts:64 *** -### options - -> **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) +### skipErrorChecking #### Inherited from -`Application.options` +`Application.skipErrorChecking` #### Defined in -node\_modules/typedoc/dist/lib/application.d.ts:61 +node\_modules/typedoc/dist/lib/application.d.ts:66 *** -### files - -> **files**: `FileRegistry` +### entryPointStrategy #### Inherited from -`Application.files` +`Application.entryPointStrategy` #### Defined in -node\_modules/typedoc/dist/lib/application.d.ts:62 +node\_modules/typedoc/dist/lib/application.d.ts:68 *** -### componentName - -> **componentName**: `string` - -The name of this component as set by the `@Component` decorator. +### entryPoints #### Inherited from -`Application.componentName` - -#### Defined in - -node\_modules/typedoc/dist/lib/utils/component.d.ts:48 - -*** - -### renderer - -> **renderer**: [`MarkdownRenderer`](MarkdownRenderer.md) - -Re-types the `renderer` instance to [`MarkdownRenderer`](MarkdownRenderer.md). - -#### Overrides - -`Application.renderer` +`Application.entryPoints` #### Defined in -[packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-application.ts#L22) - -## Accessors - -### lang - -*** - -### skipErrorChecking - -*** - -### entryPointStrategy - -*** - -### entryPoints +node\_modules/typedoc/dist/lib/application.d.ts:70 *** @@ -292,6 +169,10 @@ Return the application / root component instance. [`Application`](https://typedoc.org/api/classes/Application.html) +#### Inherited from + +`Application.application` + #### Defined in node\_modules/typedoc/dist/lib/utils/component.d.ts:61 @@ -308,6 +189,10 @@ Return the owner of this component. `O` +#### Inherited from + +`Application.owner` + #### Defined in node\_modules/typedoc/dist/lib/utils/component.d.ts:65 @@ -324,6 +209,10 @@ A unique id that identifies this instance. `any` +#### Inherited from + +`Application._listenId` + #### Defined in node\_modules/typedoc/dist/lib/utils/events.d.ts:70 diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRenderer.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRenderer.md index 0dd54114..484e370c 100644 --- a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRenderer.md +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRenderer.md @@ -8,55 +8,51 @@ An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Ren * [Extends](#extends) * [Properties](#properties) - * [theme?](#theme) - * [Inherited from](#inherited-from) - * [hooks](#hooks) - * [Inherited from](#inherited-from-1) - * [renderStartTime](#renderstarttime) - * [Inherited from](#inherited-from-2) - * [componentName](#componentname) - * [Inherited from](#inherited-from-3) - * [markdownHooks](#markdownhooks) - * [packagesMeta](#packagesmeta) - * [defineTheme()](#definetheme) - * [Overrides](#overrides) - * [preRenderAsyncJobs](#prerenderasyncjobs) - * [Overrides](#overrides-1) - * [postRenderAsyncJobs](#postrenderasyncjobs) - * [Overrides](#overrides-2) * [Accessors](#accessors) * [themeName](#themename) + * [Inherited from](#inherited-from) * [cleanOutputDir](#cleanoutputdir) + * [Inherited from](#inherited-from-1) * [cname](#cname) + * [Inherited from](#inherited-from-2) * [githubPages](#githubpages) + * [Inherited from](#inherited-from-3) * [cacheBust](#cachebust) + * [Inherited from](#inherited-from-4) * [lightTheme](#lighttheme) + * [Inherited from](#inherited-from-5) * [darkTheme](#darktheme) + * [Inherited from](#inherited-from-6) * [highlightLanguages](#highlightlanguages) + * [Inherited from](#inherited-from-7) * [pretty](#pretty) + * [Inherited from](#inherited-from-8) * [application](#application) + * [Inherited from](#inherited-from-9) * [owner](#owner) + * [Inherited from](#inherited-from-10) * [\_listenId](#_listenid) + * [Inherited from](#inherited-from-11) * [Methods](#methods) * [render()](#render) - * [Inherited from](#inherited-from-4) + * [Inherited from](#inherited-from-12) * [initialize()](#initialize) - * [Inherited from](#inherited-from-5) + * [Inherited from](#inherited-from-13) * [bubble()](#bubble) - * [Inherited from](#inherited-from-6) + * [Inherited from](#inherited-from-14) * [getComponent()](#getcomponent) - * [Inherited from](#inherited-from-7) + * [Inherited from](#inherited-from-15) * [getComponents()](#getcomponents) - * [Inherited from](#inherited-from-8) + * [Inherited from](#inherited-from-16) * [hasComponent()](#hascomponent) - * [Inherited from](#inherited-from-9) + * [Inherited from](#inherited-from-17) * [addComponent()](#addcomponent) * [Type Parameters](#type-parameters) - * [Inherited from](#inherited-from-10) + * [Inherited from](#inherited-from-18) * [removeComponent()](#removecomponent) - * [Inherited from](#inherited-from-11) + * [Inherited from](#inherited-from-19) * [removeAllComponents()](#removeallcomponents) - * [Inherited from](#inherited-from-12) + * [Inherited from](#inherited-from-20) * [on()](#on) * [on(eventMap, context)](#oneventmap-context) * [on(eventMap, callback, context, priority)](#oneventmap-callback-context-priority) @@ -69,14 +65,14 @@ An extended typing of TypeDoc's [`Renderer`](https://typedoc.org/api/classes/Ren * [off(eventMap, context)](#offeventmap-context) * [off(name, callback, context)](#offname-callback-context) * [listenTo()](#listento) - * [Inherited from](#inherited-from-21) + * [Inherited from](#inherited-from-29) * [listenToOnce()](#listentoonce) * [listenToOnce(obj, eventMap)](#listentoonceobj-eventmap) * [listenToOnce(obj, name, callback, priority)](#listentoonceobj-name-callback-priority) * [stopListening()](#stoplistening) - * [Inherited from](#inherited-from-24) + * [Inherited from](#inherited-from-32) * [trigger()](#trigger) - * [Inherited from](#inherited-from-25) + * [Inherited from](#inherited-from-33) ## Example @@ -106,190 +102,125 @@ app.renderer.postRenderAsyncJobs.push(async (output: MarkdownRendererEvent)) => ## Properties -### theme? +| Property | Flags | Type | Description | Overrides | Inherited from | +| --------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------ | -------------------------- | +| `theme?` | | [`Theme`](https://typedoc.org/api/classes/Theme.html) | The theme that is used to render the documentation. | - | `Renderer.theme` | +| `hooks` | | [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<`RendererHooks`, `JsxElement`> | Hooks which will be called when rendering pages. Note: - Hooks added during output will be discarded at the end of rendering. - Hooks added during a page render will be discarded at the end of that page's render. See RendererHooks for a description of each available hook, and when it will be called. | - | `Renderer.hooks` | +| `renderStartTime` | | `number` | - | - | `Renderer.renderStartTime` | +| `componentName` | | `string` | The name of this component as set by the `@Component` decorator. | - | `Renderer.componentName` | +| `markdownHooks` | | [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<[`MarkdownRendererHooks`](MarkdownRendererHooks.md), `string`> | Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererHooks.md) used by the plugin. | - | - | +| `packagesMeta` | `Internal` | `Record`\<`string`, `object`> | - | - | - | +| `defineTheme` | `Internal` | (`name`: `string`, `theme`: (`renderer`) => [`MarkdownTheme`](../../../../theme/classes/MarkdownTheme.md)) => `void` | - | `Renderer.defineTheme` | - | +| `preRenderAsyncJobs` | | (`output`) => `Promise`\<`void`>\[] | Re-types the returned argument argument to [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md). | `Renderer.preRenderAsyncJobs` | - | +| `postRenderAsyncJobs` | | (`output`) => `Promise`\<`void`>\[] | Re-types the returned argument argument to [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md). | `Renderer.postRenderAsyncJobs` | - | -> `optional` **theme**: [`Theme`](https://typedoc.org/api/classes/Theme.html) +## Accessors -The theme that is used to render the documentation. +### themeName #### Inherited from -`Renderer.theme` +`Renderer.themeName` #### Defined in -node\_modules/typedoc/dist/lib/output/renderer.d.ts:149 +node\_modules/typedoc/dist/lib/output/renderer.d.ts:160 *** -### hooks - -> **hooks**: [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<`RendererHooks`, `JsxElement`> - -Hooks which will be called when rendering pages. -Note: - -* Hooks added during output will be discarded at the end of rendering. -* Hooks added during a page render will be discarded at the end of that page's render. - -See RendererHooks for a description of each available hook, and when it will be called. +### cleanOutputDir #### Inherited from -`Renderer.hooks` +`Renderer.cleanOutputDir` #### Defined in -node\_modules/typedoc/dist/lib/output/renderer.d.ts:158 +node\_modules/typedoc/dist/lib/output/renderer.d.ts:161 *** -### renderStartTime - -> **renderStartTime**: `number` +### cname #### Inherited from -`Renderer.renderStartTime` +`Renderer.cname` #### Defined in -node\_modules/typedoc/dist/lib/output/renderer.d.ts:170 +node\_modules/typedoc/dist/lib/output/renderer.d.ts:162 *** -### componentName - -> **componentName**: `string` - -The name of this component as set by the `@Component` decorator. +### githubPages #### Inherited from -`Renderer.componentName` +`Renderer.githubPages` #### Defined in -node\_modules/typedoc/dist/lib/utils/component.d.ts:48 +node\_modules/typedoc/dist/lib/output/renderer.d.ts:163 *** -### markdownHooks +### cacheBust -> **markdownHooks**: [`EventHooks`](https://typedoc.org/api/classes/EventHooks.html)\<[`MarkdownRendererHooks`](MarkdownRendererHooks.md), `string`> +#### Inherited from -Replaces the event hooks typings the [`MarkdownRendererHooks`](MarkdownRendererHooks.md) used by the plugin. +`Renderer.cacheBust` #### Defined in -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L36) +node\_modules/typedoc/dist/lib/output/renderer.d.ts:165 *** -### packagesMeta +### lightTheme -`Internal` +#### Inherited from -> **packagesMeta**: `Record`\<`string`, `object`> +`Renderer.lightTheme` #### Defined in -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L38) +node\_modules/typedoc/dist/lib/output/renderer.d.ts:166 *** -### defineTheme() - -`Internal` - -> **defineTheme**: (`name`, `theme`) => `void` - -#### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------- | -| `name` | `string` | -| `theme` | (`renderer`) => [`MarkdownTheme`](../../../../theme/classes/MarkdownTheme.md) | - -#### Returns - -`void` +### darkTheme -#### Overrides +#### Inherited from -`Renderer.defineTheme` +`Renderer.darkTheme` #### Defined in -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L40) +node\_modules/typedoc/dist/lib/output/renderer.d.ts:167 *** -### preRenderAsyncJobs - -> **preRenderAsyncJobs**: (`output`) => `Promise`\<`void`>\[] - -Re-types the returned argument argument to [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md). +### highlightLanguages -#### Overrides +#### Inherited from -`Renderer.preRenderAsyncJobs` +`Renderer.highlightLanguages` #### Defined in -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L47) +node\_modules/typedoc/dist/lib/output/renderer.d.ts:168 *** -### postRenderAsyncJobs - -> **postRenderAsyncJobs**: (`output`) => `Promise`\<`void`>\[] - -Re-types the returned argument argument to [`MarkdownRendererEvent`](../../events/classes/MarkdownRendererEvent.md). +### pretty -#### Overrides +#### Inherited from -`Renderer.postRenderAsyncJobs` +`Renderer.pretty` #### Defined in -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer.ts#L51) - -## Accessors - -### themeName - -*** - -### cleanOutputDir - -*** - -### cname - -*** - -### githubPages - -*** - -### cacheBust - -*** - -### lightTheme - -*** - -### darkTheme - -*** - -### highlightLanguages - -*** - -### pretty +node\_modules/typedoc/dist/lib/output/renderer.d.ts:169 *** @@ -303,6 +234,10 @@ Return the application / root component instance. [`Application`](https://typedoc.org/api/classes/Application.html) +#### Inherited from + +`Renderer.application` + #### Defined in node\_modules/typedoc/dist/lib/utils/component.d.ts:61 @@ -319,6 +254,10 @@ Return the owner of this component. `O` +#### Inherited from + +`Renderer.owner` + #### Defined in node\_modules/typedoc/dist/lib/utils/component.d.ts:65 @@ -335,6 +274,10 @@ A unique id that identifies this instance. `any` +#### Inherited from + +`Renderer._listenId` + #### Defined in node\_modules/typedoc/dist/lib/utils/events.d.ts:70 diff --git a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRendererHooks.md b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRendererHooks.md index 016cdc64..5cceb712 100644 --- a/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRendererHooks.md +++ b/developer-docs/typedoc-plugin-markdown/app/namespaces/types/interfaces/MarkdownRendererHooks.md @@ -6,96 +6,13 @@ Describes the hooks available to inject output in the markdown theme. ## Hooks -### page.begin - -> **page.begin**: \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] - -Applied at the start of the markdown output. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L12) - -*** - -### page.end - -> **page.end**: \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] - -Applied at the end of the markdown output. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L19) - -*** - -### content.begin - -> **content.begin**: \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] - -Applied before the main markdown content is rendered. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L26) - -*** - -### index.page.begin - -> **index.page.begin**: \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] - -Applied at the start of the markdown output on the index page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L33) - -*** - -### index.content.begin - -> **index.content.begin**: \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] - -Applied before the main markdown content is rendered on the index page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L40) - -*** - -### packages.page.begin - -> **packages.page.begin**: \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] - -Applied at the start of the markdown output on the packages root page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L47) - -*** - -### packages.content.begin - -> **packages.content.begin**: \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] - -Applied before the main markdown content is rendered on the packages root page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L54) - -*** - -### index.page.end - -> **index.page.end**: \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] - -Applied at the end of the markdown output on the index page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts#L61) +| Property | Type | Description | +| ------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- | +| `page.begin` | \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] | Applied at the start of the markdown output. | +| `page.end` | \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] | Applied at the end of the markdown output. | +| `content.begin` | \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] | Applied before the main markdown content is rendered. | +| `index.page.begin` | \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] | Applied at the start of the markdown output on the index page. | +| `index.content.begin` | \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] | Applied before the main markdown content is rendered on the index page. | +| `packages.page.begin` | \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] | Applied at the start of the markdown output on the packages root page. | +| `packages.content.begin` | \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] | Applied before the main markdown content is rendered on the packages root page. | +| `index.page.end` | \[[`MarkdownThemeContext`](../../../../theme/classes/MarkdownThemeContext.md)] | Applied at the end of the markdown output on the index page. | diff --git a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/locales/README.md b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/locales/README.md index 48fc3fdf..2ca338c0 100644 --- a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/locales/README.md +++ b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/locales/README.md @@ -7,7 +7,9 @@ List of plugin specific translations per locale. ## Contents * [en](#en) +* [jp](#jp) * [ko](#ko) +* [zh](#zh) ## en @@ -25,6 +27,7 @@ Translations for 'en' locale. theme_event: 'Event', theme_extends: 'Extends', theme_extended_by: 'Extended by', + theme_flags: 'Flags', theme_member: 'Member', theme_member_plural: 'Members', theme_modifier: 'Modifier', @@ -38,7 +41,41 @@ Translations for 'en' locale. ### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L5) +[packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L5) + +*** + +## jp + +> `const` **jp**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)> + +Translations for 'jp' locale. + +### Default Value + +```ts +{ + theme_default_value: 'デフォルト値', + theme_default_type: 'デフォルトタイプ', + theme_description: '説明', + theme_event: 'イベント', + theme_extends: '拡張', + theme_extended_by: 'によって拡張された', + theme_flags: 'フラグ', + theme_member: 'メンバー', + theme_member_plural: 'メンバー', + theme_modifier: '修飾子', + theme_name: '名前', + theme_packages: 'パッケージ', + theme_type: 'タイプ', + theme_value: '値', + theme_version: 'バージョン', +} +``` + +### Defined in + +[packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L6) *** @@ -58,6 +95,7 @@ Translations for 'ko' locale. theme_event: '이벤트', theme_extends: '확장', theme_extended_by: '에 의해 확장됨', + theme_flags: '플래그', theme_member: '멤버', theme_member_plural: '멤버들', theme_modifier: '수정자', @@ -71,4 +109,38 @@ Translations for 'ko' locale. ### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L6) +[packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L6) + +*** + +## zh + +> `const` **zh**: `Partial`\<[`TranslatableStrings`](../types/interfaces/TranslatableStrings.md)> + +Translations for 'zh' locale. + +### Default Value + +```ts +{ + theme_default_value: '默认值', + theme_default_type: '默认类型', + theme_description: '描述', + theme_event: '事件', + theme_extends: '扩展', + theme_extended_by: '被扩展', + theme_flags: '标志', + theme_member: '成员', + theme_member_plural: '成员们', + theme_modifier: '修饰符', + theme_name: '名称', + theme_packages: '包', + theme_type: '类型', + theme_value: '值', + theme_version: '版本', +} +``` + +### Defined in + +[packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts:5](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L5) diff --git a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/translatable/README.md b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/translatable/README.md index 7b7827cd..477e7eb1 100644 --- a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/translatable/README.md +++ b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/translatable/README.md @@ -24,4 +24,4 @@ These will then be merged with the main set of TypeDoc string. ### Defined in -[packages/typedoc-plugin-markdown/src/internationalization/translatable.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L14) +[packages/typedoc-plugin-markdown/src/internationalization/translatable.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L14) diff --git a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/interfaces/TranslatableStrings.md b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/interfaces/TranslatableStrings.md index 018f63ec..b1c83f50 100644 --- a/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/interfaces/TranslatableStrings.md +++ b/developer-docs/typedoc-plugin-markdown/internationalization/namespaces/types/interfaces/TranslatableStrings.md @@ -6,140 +6,20 @@ The model of translatable strings specific to the Markdown theme. ## Properties -### theme\_default\_value - -> **theme\_default\_value**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L11) - -*** - -### theme\_default\_type - -> **theme\_default\_type**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L12) - -*** - -### theme\_description - -> **theme\_description**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L13) - -*** - -### theme\_event - -> **theme\_event**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L14) - -*** - -### theme\_extends - -> **theme\_extends**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L15) - -*** - -### theme\_extended\_by - -> **theme\_extended\_by**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L16) - -*** - -### theme\_member - -> **theme\_member**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:17](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L17) - -*** - -### theme\_member\_plural - -> **theme\_member\_plural**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L18) - -*** - -### theme\_modifier - -> **theme\_modifier**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L19) - -*** - -### theme\_name - -> **theme\_name**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L20) - -*** - -### theme\_packages - -> **theme\_packages**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L21) - -*** - -### theme\_type - -> **theme\_type**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L22) - -*** - -### theme\_value - -> **theme\_value**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L23) - -*** - -### theme\_version - -> **theme\_version**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/internationalization/types.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/internationalization/types.ts#L24) +| Property | Type | +| --------------------- | -------- | +| `theme_default_value` | `string` | +| `theme_default_type` | `string` | +| `theme_description` | `string` | +| `theme_event` | `string` | +| `theme_extends` | `string` | +| `theme_extended_by` | `string` | +| `theme_flags` | `string` | +| `theme_member` | `string` | +| `theme_member_plural` | `string` | +| `theme_modifier` | `string` | +| `theme_name` | `string` | +| `theme_packages` | `string` | +| `theme_type` | `string` | +| `theme_value` | `string` | +| `theme_version` | `string` | diff --git a/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md b/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md index 79f9686a..83e2bf74 100644 --- a/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md +++ b/developer-docs/typedoc-plugin-markdown/libs/namespaces/markdown/README.md @@ -39,7 +39,7 @@ If the input string itself contains a backtick, pipe, or backslash (which can re ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L7) +[packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/back-ticks.ts#L7) *** @@ -59,7 +59,7 @@ If the input string itself contains a backtick, pipe, or backslash (which can re ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/block-quote-block.ts#L1) *** @@ -79,7 +79,7 @@ If the input string itself contains a backtick, pipe, or backslash (which can re ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/bold.ts#L1) *** @@ -99,7 +99,7 @@ If the input string itself contains a backtick, pipe, or backslash (which can re ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3) +[packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/code-block.ts#L3) *** @@ -122,7 +122,7 @@ Returns a heading in markdown format ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) +[packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/heading.ts#L6) *** @@ -136,7 +136,7 @@ Returns a heading in markdown format ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/horizontal-rule.ts#L1) *** @@ -158,7 +158,7 @@ Returns a heading in markdown format ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/html-table.ts#L1) *** @@ -178,7 +178,7 @@ Returns a heading in markdown format ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/indent-block.ts#L1) *** @@ -198,7 +198,7 @@ Returns a heading in markdown format ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/italic.ts#L1) *** @@ -221,7 +221,7 @@ The link element ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) +[packages/typedoc-plugin-markdown/src/libs/markdown/link.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/link.ts#L6) *** @@ -241,7 +241,7 @@ The link element ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/strike-through.ts#L1) *** @@ -265,7 +265,7 @@ Comments for table ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) +[packages/typedoc-plugin-markdown/src/libs/markdown/table.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/table.ts#L7) *** @@ -285,4 +285,4 @@ Comments for table ### Defined in -[packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/markdown/unordered-list.ts#L1) diff --git a/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md b/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md index 71df16ff..ecaa58d0 100644 --- a/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md +++ b/developer-docs/typedoc-plugin-markdown/libs/namespaces/utils/README.md @@ -36,7 +36,7 @@ General utility pure functions. ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/camel-to-title-case.ts#L1) *** @@ -56,7 +56,7 @@ General utility pure functions. ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts#L1) *** @@ -76,7 +76,7 @@ General utility pure functions. ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/format-markdown.ts#L1) *** @@ -100,7 +100,7 @@ General utility pure functions. ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6) +[packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/format-table-cell.ts#L6) *** @@ -123,7 +123,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6) +[packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts:6](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/get-file-name-with-extension.ts#L6) *** @@ -143,7 +143,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/is-quoted.ts#L1) *** @@ -163,7 +163,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/normalize-line-breaks.ts#L1) *** @@ -183,7 +183,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3) +[packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts:3](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/remove-first-scoped-directory.ts#L3) *** @@ -203,7 +203,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/remove-line-breaks.ts#L1) *** @@ -223,7 +223,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/sanitize-comments.ts#L1) *** @@ -243,7 +243,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/slugify.ts#L1) *** @@ -263,7 +263,7 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/to-pascal-case.ts#L1) *** @@ -283,4 +283,4 @@ Returns a filename with extension while normalizing both the input name and inpu ### Defined in -[packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1) +[packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/libs/utils/un-escape-chars.ts#L1) diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md index 71493dae..3f722aaa 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/constants/README.md @@ -30,7 +30,7 @@ Default values for `membersWithOwnFile` option. ### Defined in -[packages/typedoc-plugin-markdown/src/options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/constants.ts#L12) +[packages/typedoc-plugin-markdown/src/options/constants.ts:12](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/constants.ts#L12) *** @@ -53,4 +53,4 @@ Default values for `textContentMappings` option. ### Defined in -[packages/typedoc-plugin-markdown/src/options/constants.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) +[packages/typedoc-plugin-markdown/src/options/constants.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/constants.ts#L24) diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md index d68fffb2..5db10f88 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/declarations/README.md @@ -28,11 +28,12 @@ The JSDoc comments will also be used in the public facing documentation. * [expandObjects](#expandobjects) * [expandParameters](#expandparameters) * [indexFormat](#indexformat) - * [enumMembersFormat](#enummembersformat) * [parametersFormat](#parametersformat) - * [propertiesFormat](#propertiesformat) - * [propertyMembersFormat](#propertymembersformat) + * [interfacePropertiesFormat](#interfacepropertiesformat) + * [classPropertiesFormat](#classpropertiesformat) + * [enumMembersFormat](#enummembersformat) * [typeDeclarationFormat](#typedeclarationformat) + * [propertyMembersFormat](#propertymembersformat) * [tableColumnSettings](#tablecolumnsettings) * [Utility](#utility) * [publicPath](#publicpath) @@ -101,7 +102,7 @@ Generates a single file for every Module or Namespace where all members are hois #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L66) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L66) *** @@ -139,7 +140,7 @@ Ignored when `--outputFileStrategy` is equal to `"modules"` #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:82](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L82) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:82](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L82) *** @@ -161,7 +162,7 @@ By default output files are generated in a directory structure that mirrors the #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:105](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L105) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:105](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L105) *** @@ -194,7 +195,7 @@ Typically markdown files are recognised by the `.md` or `.markdown` file extensi #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:118](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L118) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:118](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L118) *** @@ -230,7 +231,7 @@ The content of this file will be resolved in the following order: #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:147](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L147) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:147](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L147) *** @@ -261,7 +262,7 @@ Please note a separate modules index page will not be generated, therefore would #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:164](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L164) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:164](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L164) *** @@ -289,7 +290,7 @@ Ignored if `flattenOutputFiles` is set to `true`. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:180](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L180) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:180](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L180) *** @@ -314,7 +315,7 @@ This option has no effect when [`--readme`](https://typedoc.org/options/input/#r #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:194](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L194) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:194](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L194) ## Display @@ -336,7 +337,7 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:203](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L203) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:203](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L203) *** @@ -356,7 +357,7 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:212](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L212) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:212](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L212) *** @@ -376,7 +377,7 @@ Options that are used to configure how the output is structured and displayed. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:221](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L221) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:221](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L221) *** @@ -400,7 +401,7 @@ This creates a flat structure where all members are displayed at the same headin #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:234](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L234) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:234](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L234) *** @@ -426,7 +427,7 @@ As a work around the [`@link`](https://typedoc.org/tags/link/) tag can be be use #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:260](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L260) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:260](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L260) *** @@ -450,7 +451,7 @@ This option should be set when a full object representation is preferred. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:273](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L273) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:273](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L273) *** @@ -474,7 +475,7 @@ This option should be set when a full type representation is preferred. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:286](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L286) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:286](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L286) *** @@ -488,7 +489,7 @@ When table style is selected the following will be the behaviour: * For a **members index**, a description column will be added to the table with the first paragraph of the comment summary. * For a **packages index**, (when `--entryPointStrategy` equals `packages`), the package.json description will be displayed with an additional "Version" column (when `--includeVersion` equals true). -* For a **documents index** a description column will be added to the table printing the `description` frontmatter if present. +* For a **documents index** a description column will be added to the table printing the `"description"` frontmatter variable. #### Default Value @@ -503,25 +504,25 @@ When table style is selected the following will be the behaviour: #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:303](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L303) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:303](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L303) *** -### enumMembersFormat +### parametersFormat -> `const` **enumMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **parametersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> -This option specifies the output format for enumeration members: +This option specifies the output format for parameters and type parameters of functions and class methods: -* **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. -* **"table"**: members are output within a markdown table, condensed into a single paragraph. -* **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. +* **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments. +* **"table"**: parameters are output within a markdown table, condensed into a single paragraph. +* **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in table cells. #### Default Value ```ts { - help: 'Sets the format of enumeration members.', + help: 'Sets the format of parameter and type parameter groups.', type: ParameterType.Map, map: ReflectionFormat, defaultValue: ReflectionFormat.List, @@ -530,25 +531,25 @@ This option specifies the output format for enumeration members: #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:319](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L319) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:319](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L319) *** -### parametersFormat +### interfacePropertiesFormat -> `const` **parametersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **interfacePropertiesFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> -This option specifies the output format for parameters and type parameters of functions and class methods: +This option specifies the output format for interface properties: -* **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments. -* **"table"**: parameters are output within a markdown table, condensed into a single paragraph. -* **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in tabular format +* **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments. +* **"table"**: properties are output within a markdown table, condensed into a single paragraph. +* **"htmlTable"**: properties are output in an HTML table, enabling block elements to render in tabular format. #### Default Value ```ts { - help: 'Sets the format of parameter and type parameter groups.', + help: 'Sets the format of property groups for interfaces.', type: ParameterType.Map, map: ReflectionFormat, defaultValue: ReflectionFormat.List, @@ -557,15 +558,15 @@ This option specifies the output format for parameters and type parameters of fu #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:335](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L335) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:335](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L335) *** -### propertiesFormat +### classPropertiesFormat -> `const` **propertiesFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +> `const` **classPropertiesFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> -This option specifies the output format for class and interface properties: +This option specifies the output format for class properties: * **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments. * **"table"**: properties are output within a markdown table, condensed into a single paragraph. @@ -575,7 +576,7 @@ This option specifies the output format for class and interface properties: ```ts { - help: 'Sets the format of property groups for interfaces and classes.', + help: 'Sets the format of property groups for classes.', type: ParameterType.Map, map: ReflectionFormat, defaultValue: ReflectionFormat.List, @@ -584,27 +585,25 @@ This option specifies the output format for class and interface properties: #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:351](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L351) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:351](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L351) *** -### propertyMembersFormat - -> `const` **propertyMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> +### enumMembersFormat -This option will handle the formatting of object literals assigned as properties in classes or interfaces. +> `const` **enumMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> -Note this options will only take effect when `propertiesFormat` is set to `list`. +This option specifies the output format for enumeration members: -* **"list"**: declarations are output in linear blocks with headings, suitable for more detailed comments. -* **"table"**: declarations are output within a markdown table, condensed into a single paragraph. -* **"htmlTable"**: declarations are output in an HTML table, enabling block elements to render in tabular format. +* **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. +* **"table"**: members are output within a markdown table, condensed into a single paragraph. +* **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. #### Default Value ```ts { - help: 'Sets the format of style for property members for interfaces and classes.', + help: 'Sets the format of enumeration members.', type: ParameterType.Map, map: ReflectionFormat, defaultValue: ReflectionFormat.List, @@ -613,7 +612,7 @@ Note this options will only take effect when `propertiesFormat` is set to `list` #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:369](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L369) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:367](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L367) *** @@ -640,7 +639,36 @@ This option specifies the output format for type declaration of variables and ty #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:385](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L385) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:383](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L383) + +*** + +### propertyMembersFormat + +> `const` **propertyMembersFormat**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)> + +This option will handle the formatting of object literals assigned as properties in classes or interfaces. + +Note this options will only take effect when `propertiesFormat` is set to `list`. + +* **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. +* **"table"**: members are output within a markdown table, condensed into a single paragraph. +* **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. + +#### Default Value + +```ts +{ + help: 'Sets the format of style for property members for interfaces and classes.', + type: ParameterType.Map, + map: ReflectionFormat, + defaultValue: ReflectionFormat.List, +} +``` + +#### Defined in + +[packages/typedoc-plugin-markdown/src/options/declarations.ts:401](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L401) *** @@ -662,6 +690,7 @@ In addition you can control the alignment of the header text. type: ParameterType.Flags, defaults: { hideDefaults: false, + hideFlags: false, hideInherited: false, hideModifiers: false, hideOverrides: false, @@ -674,7 +703,7 @@ In addition you can control the alignment of the header text. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:401](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L401) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:431](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L431) ## Utility @@ -704,7 +733,7 @@ If undefined all urls will be relative. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:422](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L422) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:453](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L453) *** @@ -736,7 +765,7 @@ This option would typically be used when source code comes from an external libr #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:443](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L443) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:474](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L474) *** @@ -764,7 +793,7 @@ This option should be used when parsers require a custom anchor prefix. #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:456](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L456) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:487](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L487) *** @@ -789,7 +818,7 @@ This option should be used if there are issues with anchoring to symbols within #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:470](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L470) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:501](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L501) *** @@ -813,7 +842,7 @@ This option can be used for engines that require the preservation of anchor link #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:483](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L483) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:514](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L514) *** @@ -863,7 +892,7 @@ export function load(app: MarkdownApplication) { #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:519](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L519) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:550](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L550) *** @@ -904,4 +933,4 @@ If you are looking for general localization support please see [localization](). #### Defined in -[packages/typedoc-plugin-markdown/src/options/declarations.ts:543](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/declarations.ts#L543) +[packages/typedoc-plugin-markdown/src/options/declarations.ts:574](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/options/declarations.ts#L574) diff --git a/developer-docs/typedoc-plugin-markdown/options/namespaces/types/interfaces/PluginOptions.md b/developer-docs/typedoc-plugin-markdown/options/namespaces/types/interfaces/PluginOptions.md index 4bc11b6b..445127c3 100644 --- a/developer-docs/typedoc-plugin-markdown/options/namespaces/types/interfaces/PluginOptions.md +++ b/developer-docs/typedoc-plugin-markdown/options/namespaces/types/interfaces/PluginOptions.md @@ -6,426 +6,54 @@ Describes the options declared by the plugin. ## Properties -### anchorPrefix - -> **anchorPrefix**: `string` - -Custom anchor prefix when anchoring to in-page symbols. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L16) - -*** - -### entryFileName - -> **entryFileName**: `string` - -The file name of the entry page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L21) - -*** - -### entryModule - -> **entryModule**: `string` - -The name of a module that should act as the root page for the documentation. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L26) - -*** - -### enumMembersFormat - -> **enumMembersFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of enumeration members. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L31) - -*** - -### ~~excludeGroups~~ - -> **excludeGroups**: `boolean` - -#### Deprecated - -This option has been renamed hideGroupHeadings to better reflect its purpose. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L36) - -*** - -### excludeScopesInPaths - -> **excludeScopesInPaths**: `boolean` - -Exclude writing @ scope directories in paths. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L41) - -*** - -### expandObjects - -> **expandObjects**: `boolean` - -Expand objects inside declarations. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L46) - -*** - -### expandParameters - -> **expandParameters**: `boolean` - -Expand parameters in signature parentheses to display type information. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L51) - -*** - -### fileExtension - -> **fileExtension**: `string` - -Specify the file extension for generated output files. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L56) - -*** - -### flattenOutputFiles - -> **flattenOutputFiles**: `boolean` - -Flatten output files to a single directory. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L61) - -*** - -### hideBreadcrumbs - -> **hideBreadcrumbs**: `boolean` - -Do not print breadcrumbs. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L66) - -*** - -### hideGroupHeadings - -> **hideGroupHeadings**: `boolean` - -Excludes grouping by kind so all members are rendered and sorted at the same level. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:71](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L71) - -*** - -### hidePageHeader - -> **hidePageHeader**: `boolean` - -Do not print page header. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L76) - -*** - -### hidePageTitle - -> **hidePageTitle**: `boolean` - -Do not print page title. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:81](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L81) - -*** - -### indexFormat - -> **indexFormat**: `"table"` | `"list"` - -Sets the format of index items. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:86](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L86) - -*** - -### membersWithOwnFile - -> **membersWithOwnFile**: (`"Enum"` | `"Variable"` | `"Function"` | `"Class"` | `"Interface"` | `"TypeAlias"`)\[] - -Determines which members are exported to their own file when `outputFileStrategy` equals `members`. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:91](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L91) - -*** - -### mergeReadme - -> **mergeReadme**: `boolean` - -Merges the resolved readme into the project index page. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:103](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L103) - -*** - -### navigationModel - -> **navigationModel**: `object` - -Configures how the navigation model will be generated. - -#### excludeGroups - -> **excludeGroups**: `boolean` - -#### excludeCategories - -> **excludeCategories**: `boolean` - -#### excludeFolders - -> **excludeFolders**: `boolean` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:108](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L108) - -*** - -### outputFileStrategy - -> **outputFileStrategy**: `"members"` | `"modules"` - -Determines how output files are generated. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:117](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L117) - -*** - -### parametersFormat - -> **parametersFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of parameter and type parameter groups. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:122](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L122) - -*** - -### preserveAnchorCasing - -> **preserveAnchorCasing**: `boolean` - -Preserve anchor casing when generating link to symbols. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:127](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L127) - -*** - -### propertiesFormat - -> **propertiesFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of property groups for interfaces and classes. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:132](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L132) - -*** - -### propertyMembersFormat - -> **propertyMembersFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of style for property members for interfaces and classes. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:137](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L137) - -*** - -### publicPath - -> **publicPath**: `string` - -Specify the base path for all urls. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:142](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L142) - -*** - -### sanitizeComments - -> **sanitizeComments**: `boolean` - -Sanitize HTML and JSX inside JsDoc comments. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:147](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L147) - -*** - -### tableColumnSettings - -> **tableColumnSettings**: `object` - -Control how table columns are configured and displayed. - -#### hideDefaults - -> **hideDefaults**: `boolean` - -#### hideInherited - -> **hideInherited**: `boolean` - -#### hideModifiers - -> **hideModifiers**: `boolean` - -#### hideOverrides - -> **hideOverrides**: `boolean` - -#### hideSources - -> **hideSources**: `boolean` - -#### hideValues - -> **hideValues**: `boolean` - -#### leftAlignHeaders - -> **leftAlignHeaders**: `boolean` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:152](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L152) - -*** - -### textContentMappings - -> **textContentMappings**: `object` - -Change specific text placeholders in the template. - -#### header.title - -> **header.title**: `string` - -#### header.docs - -> **header.docs**: `string` - -#### breadcrumbs.home - -> **breadcrumbs.home**: `string` - -#### title.indexPage - -> **title.indexPage**: `string` - -#### title.memberPage - -> **title.memberPage**: `string` - -#### footer.text - -> **footer.text**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:165](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L165) - -*** - -### typeDeclarationFormat - -> **typeDeclarationFormat**: `"table"` | `"list"` | `"htmlTable"` - -Sets the format of style for type declaration members. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:177](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L177) - -*** - -### useCodeBlocks - -> **useCodeBlocks**: `boolean` - -Wraps signatures and declarations in code blocks. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:182](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L182) - -*** - -### useHTMLAnchors - -> **useHTMLAnchors**: `boolean` - -Add HTML named anchors to headings and table rows. - -#### Defined in - -[packages/typedoc-plugin-markdown/src/options/types.ts:187](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/options/types.ts#L187) +| Property | Type | Description | +| -------------------------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `anchorPrefix` | `string` | Custom anchor prefix when anchoring to in-page symbols. | +| `classPropertiesFormat` | `"table"` \| `"list"` \| `"htmlTable"` | Sets the format of property groups for classes. | +| `entryFileName` | `string` | The file name of the entry page. | +| `entryModule` | `string` | The name of a module that should act as the root page for the documentation. | +| `enumMembersFormat` | `"table"` \| `"list"` \| `"htmlTable"` | Sets the format of enumeration members. | +| ~~`excludeGroups`~~ | `boolean` | **Deprecated** This option has been renamed hideGroupHeadings to better reflect its purpose. | +| `excludeScopesInPaths` | `boolean` | Exclude writing @ scope directories in paths. | +| `expandObjects` | `boolean` | Expand objects inside declarations. | +| `expandParameters` | `boolean` | Expand parameters in signature parentheses to display type information. | +| `fileExtension` | `string` | Specify the file extension for generated output files. | +| `flattenOutputFiles` | `boolean` | Flatten output files to a single directory. | +| `hideBreadcrumbs` | `boolean` | Do not print breadcrumbs. | +| `hideGroupHeadings` | `boolean` | Excludes grouping by kind so all members are rendered and sorted at the same level. | +| `hidePageHeader` | `boolean` | Do not print page header. | +| `hidePageTitle` | `boolean` | Do not print page title. | +| `indexFormat` | `"table"` \| `"list"` | Sets the format of index items. | +| `interfacePropertiesFormat` | `"table"` \| `"list"` \| `"htmlTable"` | Sets the format of property groups for interfaces. | +| `membersWithOwnFile` | (`"Enum"` \| `"Variable"` \| `"Function"` \| `"Class"` \| `"Interface"` \| `"TypeAlias"`)\[] | Determines which members are exported to their own file when `outputFileStrategy` equals `members`. | +| `mergeReadme` | `boolean` | Merges the resolved readme into the project index page. | +| `navigationModel` | `object` | Configures how the navigation model will be generated. | +| `navigationModel.excludeGroups` | `boolean` | - | +| `navigationModel.excludeCategories` | `boolean` | - | +| `navigationModel.excludeFolders` | `boolean` | - | +| `outputFileStrategy` | `"members"` \| `"modules"` | Determines how output files are generated. | +| `parametersFormat` | `"table"` \| `"list"` \| `"htmlTable"` | Sets the format of parameter and type parameter groups. | +| `preserveAnchorCasing` | `boolean` | Preserve anchor casing when generating link to symbols. | +| `propertiesFormat` | `"table"` \| `"list"` \| `"htmlTable"` | Sets the format of property groups for interfaces and classes. | +| `propertyMembersFormat` | `"table"` \| `"list"` \| `"htmlTable"` | Sets the format of style for property members for interfaces and classes. | +| `publicPath` | `string` | Specify the base path for all urls. | +| `sanitizeComments` | `boolean` | Sanitize HTML and JSX inside JsDoc comments. | +| `tableColumnSettings` | `object` | Control how table columns are configured and displayed. | +| `tableColumnSettings.hideDefaults` | `boolean` | - | +| `tableColumnSettings.hideFlags` | `boolean` | - | +| `tableColumnSettings.hideInherited` | `boolean` | - | +| `tableColumnSettings.hideModifiers` | `boolean` | - | +| `tableColumnSettings.hideOverrides` | `boolean` | - | +| `tableColumnSettings.hideSources` | `boolean` | - | +| `tableColumnSettings.hideValues` | `boolean` | - | +| `tableColumnSettings.leftAlignHeaders` | `boolean` | - | +| `textContentMappings` | `object` | Change specific text placeholders in the template. | +| `textContentMappings.header.title` | `string` | - | +| `textContentMappings.header.docs` | `string` | - | +| `textContentMappings.breadcrumbs.home` | `string` | - | +| `textContentMappings.title.indexPage` | `string` | - | +| `textContentMappings.title.memberPage` | `string` | - | +| `textContentMappings.footer.text` | `string` | - | +| `typeDeclarationFormat` | `"table"` \| `"list"` \| `"htmlTable"` | Sets the format of style for type declaration members. | +| `useCodeBlocks` | `boolean` | Wraps signatures and declarations in code blocks. | +| `useHTMLAnchors` | `boolean` | Add HTML named anchors to headings and table rows. | diff --git a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md b/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md index b0e13f69..2d1305dd 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md +++ b/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownTheme.md @@ -20,13 +20,16 @@ The API follows the implementation of [TypeDoc's custom theming](https://github. * [Inherited from](#inherited-from-1) * [Accessors](#accessors) * [application](#application) + * [Inherited from](#inherited-from-2) * [owner](#owner) + * [Inherited from](#inherited-from-3) * [\_listenId](#_listenid) + * [Inherited from](#inherited-from-4) * [Methods](#methods) * [initialize()](#initialize) - * [Inherited from](#inherited-from-2) + * [Inherited from](#inherited-from-5) * [bubble()](#bubble) - * [Inherited from](#inherited-from-3) + * [Inherited from](#inherited-from-6) * [on()](#on) * [on(eventMap, context)](#oneventmap-context) * [on(eventMap, callback, context, priority)](#oneventmap-callback-context-priority) @@ -39,14 +42,14 @@ The API follows the implementation of [TypeDoc's custom theming](https://github. * [off(eventMap, context)](#offeventmap-context) * [off(name, callback, context)](#offname-callback-context) * [listenTo()](#listento) - * [Inherited from](#inherited-from-12) + * [Inherited from](#inherited-from-15) * [listenToOnce()](#listentoonce) * [listenToOnce(obj, eventMap)](#listentoonceobj-eventmap) * [listenToOnce(obj, name, callback, priority)](#listentoonceobj-name-callback-priority) * [stopListening()](#stoplistening) - * [Inherited from](#inherited-from-15) + * [Inherited from](#inherited-from-18) * [trigger()](#trigger) - * [Inherited from](#inherited-from-16) + * [Inherited from](#inherited-from-19) * [render()](#render) * [Overrides](#overrides) * [getRenderContext()](#getrendercontext) @@ -129,6 +132,10 @@ Return the application / root component instance. [`Application`](https://typedoc.org/api/classes/Application.html) +#### Inherited from + +`Theme.application` + #### Defined in node\_modules/typedoc/dist/lib/utils/component.d.ts:61 @@ -145,6 +152,10 @@ Return the owner of this component. `O` +#### Inherited from + +`Theme.owner` + #### Defined in node\_modules/typedoc/dist/lib/utils/component.d.ts:65 @@ -161,6 +172,10 @@ A unique id that identifies this instance. `any` +#### Inherited from + +`Theme._listenId` + #### Defined in node\_modules/typedoc/dist/lib/utils/events.d.ts:70 @@ -567,10 +582,10 @@ node\_modules/typedoc/dist/lib/utils/events.d.ts:122 ### render() -`Internal` - > **render**(`page`, `template`): `string` +`Internal` + Renders a template and page model to a string. #### Parameters @@ -590,7 +605,7 @@ Renders a template and page model to a string. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L43) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L43) *** @@ -614,7 +629,7 @@ This method can be overridden to provide an alternative theme context. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L60) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L60) *** @@ -642,7 +657,7 @@ This method can be overriden to provide an alternative url structure. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L69) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:69](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L69) *** @@ -666,16 +681,16 @@ This method can be overriden to provide an alternative navigation structure. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L78) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L78) *** ### getTemplateMapping() -`Internal` - > **getTemplateMapping**(`kind`, `outputFileStrategy`?): `any` +`Internal` + #### Parameters | Parameter | Type | @@ -689,16 +704,16 @@ This method can be overriden to provide an alternative navigation structure. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:85](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L85) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:85](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L85) *** ### documentTemplate() -`Internal` - > **documentTemplate**(`page`): `string` +`Internal` + #### Parameters | Parameter | Type | @@ -711,16 +726,16 @@ This method can be overriden to provide an alternative navigation structure. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:209](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L209) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:209](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L209) *** ### readmeTemplate() -`Internal` - > **readmeTemplate**(`page`): `string` +`Internal` + #### Parameters | Parameter | Type | @@ -733,16 +748,16 @@ This method can be overriden to provide an alternative navigation structure. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:216](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L216) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:216](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L216) *** ### projectTemplate() -`Internal` - > **projectTemplate**(`page`): `string` +`Internal` + #### Parameters | Parameter | Type | @@ -755,16 +770,16 @@ This method can be overriden to provide an alternative navigation structure. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:223](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L223) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:223](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L223) *** ### reflectionTemplate() -`Internal` - > **reflectionTemplate**(`page`): `string` +`Internal` + #### Parameters | Parameter | Type | @@ -777,4 +792,4 @@ This method can be overriden to provide an alternative navigation structure. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:230](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L230) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts:230](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme.ts#L230) diff --git a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md b/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md index 225d60ec..f9c46e3d 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md +++ b/developer-docs/typedoc-plugin-markdown/theme/classes/MarkdownThemeContext.md @@ -129,7 +129,7 @@ This class can be used to customize the theme output by extending the class and #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:43](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L43) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L42) ## Properties @@ -141,7 +141,7 @@ Properties are passed into the constructor and are used to provide context to th #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L37) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L36) *** @@ -151,7 +151,7 @@ Properties are passed into the constructor and are used to provide context to th #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L38) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L37) *** @@ -163,7 +163,7 @@ The theme instance. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L47) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L46) *** @@ -175,7 +175,7 @@ The current page event. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:51](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L51) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L50) *** @@ -187,7 +187,7 @@ The options provided to the application. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:55](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L55) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L54) *** @@ -201,7 +201,7 @@ This is required for generating package specific documentation. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:67](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L67) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L66) ## Methods @@ -225,7 +225,7 @@ Returns the package meta data for a given package name when entrypointStrategy i #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:115](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L115) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:114](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L114) *** @@ -250,16 +250,16 @@ If public path is set, it will be used as the base URL. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:127](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L127) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:126](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L126) *** ### hook() -`Internal` - > **hook**(`name`): `string`\[] +`Internal` + Hook into the TypeDoc rendering system. #### Parameters @@ -274,7 +274,7 @@ Hook into the TypeDoc rendering system. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:157](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L157) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:156](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L156) ## Resources @@ -354,7 +354,7 @@ Template that maps to individual reflection models. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:75](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L75) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:74](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L74) *** @@ -454,6 +454,7 @@ Partials are categorised by their use: | `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/Models.ReflectionGroup.html)\[] | | `options` | `object` | | `options.headingLevel` | `number` | +| `options.kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | ##### Returns @@ -1267,7 +1268,7 @@ There is no association list partial for properties as these are handled as a st #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:95](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L95) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:94](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L94) *** @@ -1285,7 +1286,7 @@ Please note that partials: #### getCommentFlags() -> **getCommentFlags**: (`reflection`) => `string`\[] +> **getCommentFlags**: (`reflection`) => `string` ##### Parameters @@ -1295,7 +1296,7 @@ Please note that partials: ##### Returns -`string`\[] +`string` #### getCommentParts() @@ -1529,13 +1530,14 @@ Please note that partials: #### useTableFormat() -> **useTableFormat**: (`key`) => `boolean` +> **useTableFormat**: (`key`, `reflectionKind`?) => `boolean` ##### Parameters -| Parameter | Type | -| --------- | -------------------------------------------------------------------------------------------- | -| `key` | `"parameters"` \| `"properties"` \| `"enums"` \| `"typeDeclarations"` \| `"propertyMembers"` | +| Parameter | Type | +| ----------------- | -------------------------------------------------------------------------------------------- | +| `key` | `"parameters"` \| `"properties"` \| `"enums"` \| `"typeDeclarations"` \| `"propertyMembers"` | +| `reflectionKind`? | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | ##### Returns @@ -1543,4 +1545,4 @@ Please note that partials: #### Defined in -[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:108](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L108) +[packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts:107](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/markdown-theme-context.ts#L107) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/NavigationBuilder.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/NavigationBuilder.md index 40261145..ec2ec5bb 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/NavigationBuilder.md +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/NavigationBuilder.md @@ -42,7 +42,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L25) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L25) ## Properties @@ -52,7 +52,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L19) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L19) *** @@ -62,7 +62,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L20) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L20) *** @@ -72,7 +72,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L21) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L21) *** @@ -88,7 +88,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L22) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L22) *** @@ -98,7 +98,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L23) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L23) *** @@ -108,7 +108,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L26) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L26) *** @@ -118,7 +118,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L27) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L27) ## Methods @@ -132,7 +132,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L40) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L40) *** @@ -152,7 +152,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L56) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:56](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L56) *** @@ -172,7 +172,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:117](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L117) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:117](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L117) *** @@ -192,7 +192,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:190](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L190) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:190](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L190) *** @@ -213,7 +213,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:207](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L207) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:207](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L207) *** @@ -234,7 +234,7 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:252](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L252) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:252](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L252) *** @@ -256,4 +256,4 @@ #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:312](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L312) +[packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts:312](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/navigation-builder.ts#L312) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/UrlBuilder.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/UrlBuilder.md index 60ca3876..75ac98e3 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/UrlBuilder.md +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/core/classes/UrlBuilder.md @@ -63,7 +63,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L40) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L40) ## Properties @@ -73,7 +73,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L30) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L30) *** @@ -83,7 +83,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L31) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L31) *** @@ -93,7 +93,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L32) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L32) *** @@ -103,7 +103,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L33) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L33) *** @@ -113,7 +113,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L34) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L34) *** @@ -123,7 +123,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L35) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L35) *** @@ -133,7 +133,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L36) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L36) *** @@ -149,7 +149,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L37) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L37) *** @@ -165,7 +165,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L38) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L38) *** @@ -175,7 +175,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L41) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L41) *** @@ -185,7 +185,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L42) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L42) ## Methods @@ -199,7 +199,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:65](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L65) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:65](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L65) *** @@ -213,7 +213,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:83](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L83) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:83](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L83) *** @@ -237,7 +237,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:133](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L133) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:133](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L133) *** @@ -257,7 +257,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:157](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L157) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:157](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L157) *** @@ -277,7 +277,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:261](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L261) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:261](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L261) *** @@ -298,7 +298,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:305](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L305) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:305](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L305) *** @@ -320,7 +320,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:373](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L373) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:373](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L373) *** @@ -340,7 +340,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:401](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L401) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:401](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L401) *** @@ -360,7 +360,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:421](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L421) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:421](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L421) *** @@ -381,7 +381,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:431](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L431) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:431](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L431) *** @@ -402,7 +402,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:479](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L479) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:479](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L479) *** @@ -423,7 +423,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:498](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L498) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:498](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L498) *** @@ -443,7 +443,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:534](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L534) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:534](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L534) *** @@ -463,7 +463,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:546](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L546) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:546](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L546) *** @@ -483,7 +483,7 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:574](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L574) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:582](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L582) *** @@ -504,4 +504,4 @@ The project whose urls should be generated. #### Defined in -[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:580](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L580) +[packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts:588](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts#L588) diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/NavigationItem.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/NavigationItem.md index d77cef60..00e5e79a 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/NavigationItem.md +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/NavigationItem.md @@ -6,40 +6,9 @@ The model used to define the navigation structure. ## Properties -### title - -> **title**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L29) - -*** - -### path? - -> `optional` **path**: `null` | `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L30) - -*** - -### kind? - -> `optional` **kind**: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L31) - -*** - -### children? - -> `optional` **children**: [`NavigationItem`](NavigationItem.md)\[] - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L32) +| Property | Type | +| ----------- | ------------------------------------------------------------------------------ | +| `title` | `string` | +| `path?` | `null` \| `string` | +| `kind?` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | +| `children?` | [`NavigationItem`](NavigationItem.md)\[] | diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/PackageMetaData.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/PackageMetaData.md index 2784699d..9ff8f1c6 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/PackageMetaData.md +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/PackageMetaData.md @@ -6,20 +6,7 @@ The model used to define the package metadata when in packages mode. ## Properties -### description - -> **description**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L10) - -*** - -### options - -> **options**: [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L11) +| Property | Type | +| ------------- | ----------------------------------------------------------------------- | +| `description` | `string` | +| `options` | [`Options`](https://typedoc.org/api/classes/Configuration.Options.html) | diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/TemplateMapping.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/TemplateMapping.md index 864434cd..4467c790 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/TemplateMapping.md +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/TemplateMapping.md @@ -4,30 +4,8 @@ ## Properties -### directory - -> **directory**: `null` | `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L38) - -*** - -### template - -> **template**: `any` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L39) - -*** - -### kind - -> **kind**: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L40) +| Property | Type | +| ----------- | ------------------------------------------------------------------------------ | +| `directory` | `null` \| `string` | +| `template` | `any` | +| `kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlMapping.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlMapping.md index 84be7716..dd72048a 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlMapping.md +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlMapping.md @@ -8,9 +8,6 @@ The model used to define the URL mapping structure. * [Type Parameters](#type-parameters) * [Properties](#properties) - * [url](#url) - * [model](#model) - * [template()](#template) ## Type Parameters @@ -20,40 +17,8 @@ The model used to define the URL mapping structure. ## Properties -### url - -> **url**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L19) - -*** - -### model - -> **model**: `Model` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L20) - -*** - -### template() - -> **template**: (`data`) => `string` - -#### Parameters - -| Parameter | Type | -| --------- | ----------------------------------------------------------------------------------------------- | -| `data` | [`MarkdownPageEvent`](../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<`Model`> | - -#### Returns - -`string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L21) +| Property | Type | +| ---------- | --------------------------------------------------------------------------------------------------------------------- | +| `url` | `string` | +| `model` | `Model` | +| `template` | (`data`: [`MarkdownPageEvent`](../../../../app/namespaces/events/classes/MarkdownPageEvent.md)\<`Model`>) => `string` | diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlOption.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlOption.md index 5085b0b2..a5632c7b 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlOption.md +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/interfaces/UrlOption.md @@ -4,60 +4,11 @@ ## Properties -### parentUrl? - -> `optional` **parentUrl**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:44](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L44) - -*** - -### directory? - -> `optional` **directory**: `null` | `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L45) - -*** - -### forceDirectory? - -> `optional` **forceDirectory**: `boolean` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:46](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L46) - -*** - -### outputFileStrategy? - -> `optional` **outputFileStrategy**: [`OutputFileStrategy`](../../../../options/namespaces/maps/enumerations/OutputFileStrategy.md) - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:47](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L47) - -*** - -### entryModule? - -> `optional` **entryModule**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L48) - -*** - -### entryFileName? - -> `optional` **entryFileName**: `string` - -#### Defined in - -[packages/typedoc-plugin-markdown/src/theme/types.ts:49](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L49) +| Property | Type | +| --------------------- | ---------------------------------------------------------------------------------------------- | +| `parentUrl?` | `string` | +| `directory?` | `null` \| `string` | +| `forceDirectory?` | `boolean` | +| `outputFileStrategy?` | [`OutputFileStrategy`](../../../../options/namespaces/maps/enumerations/OutputFileStrategy.md) | +| `entryModule?` | `string` | +| `entryFileName?` | `string` | diff --git a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/type-aliases/RenderTemplate.md b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/type-aliases/RenderTemplate.md index 163e2cbe..24a8bef6 100644 --- a/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/type-aliases/RenderTemplate.md +++ b/developer-docs/typedoc-plugin-markdown/theme/namespaces/types/type-aliases/RenderTemplate.md @@ -22,4 +22,4 @@ ## Defined in -[packages/typedoc-plugin-markdown/src/theme/types.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/theme/types.ts#L35) +[packages/typedoc-plugin-markdown/src/theme/types.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/theme/types.ts#L35) diff --git a/docs/pages/docs/changelog/v4.1.mdx b/docs/pages/docs/changelog/v4.1.mdx index be787b09..eed45007 100644 --- a/docs/pages/docs/changelog/v4.1.mdx +++ b/docs/pages/docs/changelog/v4.1.mdx @@ -16,7 +16,11 @@ This release contains required internal api fixes and theme updates to support T - Exposed a new key `"htmlTable"` to formatting options enabling block elements to render as intended inside table cells. Affects all existing formatting options. Fixes [(#618)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/618). -- Added new option to control formatting of object literal property members for classes and interfaces. +- Added new formatting options + , + and + to further control + formatting of different declaration structures. - Supports the ability to control what table columns are rendered with the option. ## Non-Breaking Changes diff --git a/docs/pages/docs/options.mdx b/docs/pages/docs/options.mdx index b7df8a55..316e88a5 100644 --- a/docs/pages/docs/options.mdx +++ b/docs/pages/docs/options.mdx @@ -32,11 +32,12 @@ Options that are used to configure how the output is structured and displayed. - [--expandObjects](./options/display-options.mdx#--expandobjects) - [--expandParameters](./options/display-options.mdx#--expandparameters) - [--indexFormat](./options/display-options.mdx#--indexformat) -- [--enumMembersFormat](./options/display-options.mdx#--enummembersformat) - [--parametersFormat](./options/display-options.mdx#--parametersformat) -- [--propertiesFormat](./options/display-options.mdx#--propertiesformat) -- [--propertyMembersFormat](./options/display-options.mdx#--propertymembersformat) +- [--interfacePropertiesFormat](./options/display-options.mdx#--interfacepropertiesformat) +- [--classPropertiesFormat](./options/display-options.mdx#--classpropertiesformat) +- [--enumMembersFormat](./options/display-options.mdx#--enummembersformat) - [--typeDeclarationFormat](./options/display-options.mdx#--typedeclarationformat) +- [--propertyMembersFormat](./options/display-options.mdx#--propertymembersformat) - [--tableColumnSettings](./options/display-options.mdx#--tablecolumnsettings) ## Utility Options diff --git a/docs/pages/docs/options/display-options.mdx b/docs/pages/docs/options/display-options.mdx index 2a5e9d5a..b0610495 100644 --- a/docs/pages/docs/options/display-options.mdx +++ b/docs/pages/docs/options/display-options.mdx @@ -123,7 +123,7 @@ When table style is selected the following will be the behaviour: - For a **members index**, a description column will be added to the table with the first paragraph of the comment summary. - For a **packages index**, (when `--entryPointStrategy` equals `packages`), the package.json description will be displayed with an additional "Version" column (when `--includeVersion` equals true). -- For a **documents index** a description column will be added to the table printing the `description` frontmatter if present. +- For a **documents index** a description column will be added to the table printing the `"description"` frontmatter variable. ```json filename="typedoc.json" { @@ -131,53 +131,51 @@ When table style is selected the following will be the behaviour: } ``` -## --enumMembersFormat +## --parametersFormat -Sets the format of enumeration members. + + Sets the format of parameter and type parameter groups. + > Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`. -This option specifies the output format for enumeration members: +This option specifies the output format for parameters and type parameters of functions and class methods: -- **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. -- **"table"**: members are output within a markdown table, condensed into a single paragraph. -- **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. +- **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments. +- **"table"**: parameters are output within a markdown table, condensed into a single paragraph. +- **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in table cells. ```json filename="typedoc.json" { - "enumMembersFormat": "list" + "parametersFormat": "list" } ``` -## --parametersFormat +## --interfacePropertiesFormat - - Sets the format of parameter and type parameter groups. - +Sets the format of property groups for interfaces. > Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`. -This option specifies the output format for parameters and type parameters of functions and class methods: +This option specifies the output format for interface properties: -- **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments. -- **"table"**: parameters are output within a markdown table, condensed into a single paragraph. -- **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in tabular format +- **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments. +- **"table"**: properties are output within a markdown table, condensed into a single paragraph. +- **"htmlTable"**: properties are output in an HTML table, enabling block elements to render in tabular format. ```json filename="typedoc.json" { - "parametersFormat": "list" + "interfacePropertiesFormat": "list" } ``` -## --propertiesFormat +## --classPropertiesFormat - - Sets the format of property groups for interfaces and classes. - +Sets the format of property groups for classes. > Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`. -This option specifies the output format for class and interface properties: +This option specifies the output format for class properties: - **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments. - **"table"**: properties are output within a markdown table, condensed into a single paragraph. @@ -185,29 +183,25 @@ This option specifies the output format for class and interface properties: ```json filename="typedoc.json" { - "propertiesFormat": "list" + "classPropertiesFormat": "list" } ``` -## --propertyMembersFormat +## --enumMembersFormat - - Sets the format of style for property members for interfaces and classes. - +Sets the format of enumeration members. > Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`. -This option will handle the formatting of object literals assigned as properties in classes or interfaces. - -Note this options will only take effect when `propertiesFormat` is set to `list`. +This option specifies the output format for enumeration members: -- **"list"**: declarations are output in linear blocks with headings, suitable for more detailed comments. -- **"table"**: declarations are output within a markdown table, condensed into a single paragraph. -- **"htmlTable"**: declarations are output in an HTML table, enabling block elements to render in tabular format. +- **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. +- **"table"**: members are output within a markdown table, condensed into a single paragraph. +- **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. ```json filename="typedoc.json" { - "propertyMembersFormat": "list" + "enumMembersFormat": "list" } ``` @@ -231,6 +225,28 @@ This option specifies the output format for type declaration of variables and ty } ``` +## --propertyMembersFormat + + + Sets the format of style for property members for interfaces and classes. + + +> Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`. + +This option will handle the formatting of object literals assigned as properties in classes or interfaces. + +Note this options will only take effect when `propertiesFormat` is set to `list`. + +- **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. +- **"table"**: members are output within a markdown table, condensed into a single paragraph. +- **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. + +```json filename="typedoc.json" +{ + "propertyMembersFormat": "list" +} +``` + ## --tableColumnSettings diff --git a/docs/public/schema.json b/docs/public/schema.json index 78abb170..2c2da911 100644 --- a/docs/public/schema.json +++ b/docs/public/schema.json @@ -11,6 +11,16 @@ "type": "string", "description": "[typedoc-plugin-markdown] Custom anchor prefix when anchoring to in-page symbols." }, + "classPropertiesFormat": { + "type": "string", + "enum": [ + "list", + "table", + "htmlTable" + ], + "description": "[typedoc-plugin-markdown] Sets the format of property groups for classes.", + "default": "list" + }, "entryFileName": { "type": "string", "description": "[typedoc-plugin-markdown] The file name of the entry page.", @@ -24,14 +34,16 @@ "type": "string", "enum": [ "list", - "table" + "table", + "htmlTable" ], - "description": "[typedoc-plugin-markdown] Specify the render style of enumeration members.", + "description": "[typedoc-plugin-markdown] Sets the format of enumeration members.", "default": "list" }, "excludeGroups": { "type": "boolean", - "description": "[typedoc-plugin-markdown] Excludes grouping by kind so all members are rendered and sorted at the same level." + "deprecated": "This option has been renamed hideGroupHeadings to better reflect its purpose.", + "description": "[typedoc-plugin-markdown] undefined" }, "excludeScopesInPaths": { "type": "boolean", @@ -58,6 +70,10 @@ "type": "boolean", "description": "[typedoc-plugin-markdown] Do not print breadcrumbs." }, + "hideGroupHeadings": { + "type": "boolean", + "description": "[typedoc-plugin-markdown] Excludes grouping by kind so all members are rendered and sorted at the same level." + }, "hidePageHeader": { "type": "boolean", "description": "[typedoc-plugin-markdown] Do not print page header." @@ -72,7 +88,17 @@ "list", "table" ], - "description": "[typedoc-plugin-markdown] Specify the render format for index items.", + "description": "[typedoc-plugin-markdown] Sets the format of index items.", + "default": "list" + }, + "interfacePropertiesFormat": { + "type": "string", + "enum": [ + "list", + "table", + "htmlTable" + ], + "description": "[typedoc-plugin-markdown] Sets the format of property groups for interfaces.", "default": "list" }, "membersWithOwnFile": { @@ -135,9 +161,10 @@ "type": "string", "enum": [ "list", - "table" + "table", + "htmlTable" ], - "description": "[typedoc-plugin-markdown] Specify the render style of parameter and type parameter groups.", + "description": "[typedoc-plugin-markdown] Sets the format of parameter and type parameter groups.", "default": "list" }, "preserveAnchorCasing": { @@ -148,9 +175,20 @@ "type": "string", "enum": [ "list", - "table" + "table", + "htmlTable" + ], + "description": "[typedoc-plugin-markdown] Sets the format of property groups for interfaces and classes.", + "default": "list" + }, + "propertyMembersFormat": { + "type": "string", + "enum": [ + "list", + "table", + "htmlTable" ], - "description": "[typedoc-plugin-markdown] Specify the render style of property groups for interfaces and classes.", + "description": "[typedoc-plugin-markdown] Sets the format of style for property members for interfaces and classes.", "default": "list" }, "publicPath": { @@ -161,285 +199,82 @@ "type": "boolean", "description": "[typedoc-plugin-markdown] Sanitize HTML and JSX inside JsDoc comments." }, - "textContentMappings": { + "tableColumnSettings": { "type": "object", "properties": { - "header.title": { - "type": "string" - }, - "header.docs": { - "type": "string" - }, - "breadcrumbs.home": { - "type": "string" - }, - "footer.text": { - "type": "string" - }, - "title.indexPage": { - "type": "string" - }, - "title.modulePage": { - "type": "string" - }, - "title.memberPage": { - "type": "string" - }, - "label.apiIndex": { - "type": "string" - }, - "label.defaultValue": { - "type": "string" - }, - "label.description": { - "type": "string" - }, - "label.extendedBy": { - "type": "string" - }, - "label.extends": { - "type": "string" - }, - "label.flags": { - "type": "string" - }, - "label.globals": { - "type": "string" - }, - "label.implements": { - "type": "string" - }, - "label.implementationOf": { - "type": "string" - }, - "label.inheritedFrom": { - "type": "string" - }, - "label.index": { - "type": "string" - }, - "label.indexable": { - "type": "string" - }, - "label.indexSignature": { - "type": "string" - }, - "label.member": { - "type": "string" - }, - "label.modifier": { - "type": "string" - }, - "label.name": { - "type": "string" - }, - "label.overrides": { - "type": "string" - }, - "label.packages": { - "type": "string" - }, - "label.reExports": { - "type": "string" - }, - "label.renamesAndReExports": { - "type": "string" - }, - "label.returns": { - "type": "string" - }, - "label.source": { - "type": "string" - }, - "label.type": { - "type": "string" - }, - "label.typeDeclaration": { - "type": "string" - }, - "label.value": { - "type": "string" - }, - "kind.accessor.singular": { - "type": "string" - }, - "kind.accessor.plural": { - "type": "string" - }, - "kind.class.singular": { - "type": "string" - }, - "kind.class.plural": { - "type": "string" - }, - "kind.constructor.singular": { - "type": "string" - }, - "kind.constructor.plural": { - "type": "string" - }, - "kind.enum.singular": { - "type": "string" - }, - "kind.enum.plural": { - "type": "string" - }, - "kind.enumMember.singular": { - "type": "string" - }, - "kind.enumMember.plural": { - "type": "string" - }, - "kind.event.singular": { - "type": "string" - }, - "kind.event.plural": { - "type": "string" - }, - "kind.function.singular": { - "type": "string" - }, - "kind.function.plural": { - "type": "string" - }, - "kind.interface.singular": { - "type": "string" - }, - "kind.interface.plural": { - "type": "string" - }, - "kind.method.singular": { - "type": "string" - }, - "kind.method.plural": { - "type": "string" - }, - "kind.module.singular": { - "type": "string" - }, - "kind.module.plural": { - "type": "string" - }, - "kind.namespace.singular": { - "type": "string" - }, - "kind.namespace.plural": { - "type": "string" - }, - "kind.variable.singular": { - "type": "string" + "hideDefaults": { + "type": "boolean" }, - "kind.variable.plural": { - "type": "string" + "hideInherited": { + "type": "boolean" }, - "kind.parameter.singular": { - "type": "string" + "hideModifiers": { + "type": "boolean" }, - "kind.parameter.plural": { - "type": "string" + "hideOverrides": { + "type": "boolean" }, - "kind.property.singular": { - "type": "string" + "hideSources": { + "type": "boolean" }, - "kind.property.plural": { - "type": "string" + "hideValues": { + "type": "boolean" }, - "kind.reference.singular": { + "leftAlignHeaders": { + "type": "boolean" + } + }, + "description": "[typedoc-plugin-markdown] Control how table columns are configured and displayed.", + "default": { + "hideDefaults": false, + "hideInherited": false, + "hideModifiers": false, + "hideOverrides": false, + "hideSources": false, + "hideValues": false, + "leftAlignHeaders": false + } + }, + "textContentMappings": { + "type": "object", + "properties": { + "header.title": { "type": "string" }, - "kind.reference.plural": { + "header.docs": { "type": "string" }, - "kind.typeAlias.singular": { + "breadcrumbs.home": { "type": "string" }, - "kind.typeAlias.plural": { + "title.indexPage": { "type": "string" }, - "kind.typeParameter.singular": { + "title.memberPage": { "type": "string" }, - "kind.typeParameter.plural": { + "footer.text": { "type": "string" } }, - "description": "[typedoc-plugin-markdown] Provides a mechanism to change the content of text used in documentation.", + "description": "[typedoc-plugin-markdown] Change specific text placeholders in the template.", "default": { "header.title": "{projectName} {version}", "header.docs": "Docs", "breadcrumbs.home": "{projectName} {version}", - "footer.text": "", "title.indexPage": "{projectName} {version}", - "title.modulePage": "{name}", "title.memberPage": "{kind}: {name}", - "label.apiIndex": "API Index", - "label.defaultValue": "Default value", - "label.description": "Description", - "label.extendedBy": "Extended by", - "label.extends": "Extends", - "label.flags": "Flags", - "label.globals": "Globals", - "label.implements": "Implements", - "label.implementationOf": "Implementation of", - "label.inheritedFrom": "Inherited from", - "label.index": "Index", - "label.indexable": "Indexable", - "label.indexSignature": "Index signature", - "label.member": "Member", - "label.modifier": "Modifier", - "label.name": "Name", - "label.overrides": "Overrides", - "label.packages": "Packages", - "label.reExports": "Re-exports", - "label.renamesAndReExports": "Renames and re-exports", - "label.returns": "Returns", - "label.source": "Source", - "label.type": "Type", - "label.typeDeclaration": "Type declaration", - "label.value": "Value", - "kind.accessor.singular": "Accessor", - "kind.accessor.plural": "Accessors", - "kind.class.singular": "Class", - "kind.class.plural": "Classes", - "kind.constructor.singular": "Constructor", - "kind.constructor.plural": "Constructors", - "kind.enum.singular": "Enumeration", - "kind.enum.plural": "Enumerations", - "kind.enumMember.singular": "Enumeration Member", - "kind.enumMember.plural": "Enumeration Members", - "kind.event.singular": "Event", - "kind.event.plural": "Events", - "kind.function.singular": "Function", - "kind.function.plural": "Functions", - "kind.interface.singular": "Interface", - "kind.interface.plural": "Interfaces", - "kind.method.singular": "Method", - "kind.method.plural": "Methods", - "kind.module.singular": "Module", - "kind.module.plural": "Modules", - "kind.namespace.singular": "Namespace", - "kind.namespace.plural": "Namespaces", - "kind.variable.singular": "Variable", - "kind.variable.plural": "Variables", - "kind.parameter.singular": "Parameter", - "kind.parameter.plural": "Parameters", - "kind.property.singular": "Property", - "kind.property.plural": "Properties", - "kind.reference.singular": "Reference", - "kind.reference.plural": "References", - "kind.typeAlias.singular": "Type alias", - "kind.typeAlias.plural": "Type Aliases", - "kind.typeParameter.singular": "Type parameter", - "kind.typeParameter.plural": "Type parameters" + "footer.text": "" } }, "typeDeclarationFormat": { "type": "string", "enum": [ "list", - "table" + "table", + "htmlTable" ], - "description": "[typedoc-plugin-markdown] Specify the render style for type declaration members.", + "description": "[typedoc-plugin-markdown] Sets the format of style for type declaration members.", "default": "list" }, "useCodeBlocks": { diff --git a/package-lock.json b/package-lock.json index beae4018..eb0de1ac 100644 --- a/package-lock.json +++ b/package-lock.json @@ -45,7 +45,7 @@ "ts-morph": "^22.0.0", "ts-node": "^10.9.2", "tsc-alias": "^1.8.10", - "typedoc": "^0.26.0-beta.4", + "typedoc": "^0.26.0-beta.5", "typescript": "^5.4.5", "unified-prettier": "^2.0.1" } @@ -5064,9 +5064,9 @@ "dev": true }, "node_modules/@shikijs/core": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.6.1.tgz", - "integrity": "sha512-CqYyepN4SnBopaoXYwng4NO8riB5ask/LTCkhOFq+GNGtr2X+aKeD767eYdqYukeixEUvv4bXdyTYVaogj7KBw==" + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.7.0.tgz", + "integrity": "sha512-O6j27b7dGmJbR3mjwh/aHH8Ld+GQvA0OQsNO43wKWnqbAae3AYXrhFyScHGX8hXZD6vX2ngjzDFkZY5srtIJbQ==" }, "node_modules/@sideway/address": { "version": "4.1.5", @@ -20424,11 +20424,11 @@ } }, "node_modules/shiki": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.6.1.tgz", - "integrity": "sha512-1Pu/A1rtsG6HZvQm4W0NExQ45e02og+rPog7PDaFDiMumZgOYnZIu4JtGQeAIfMwdbKSjJQoCUr79vDLKUUxWA==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.7.0.tgz", + "integrity": "sha512-H5pMn4JA7ayx8H0qOz1k2qANq6mZVCMl1gKLK6kWIrv1s2Ial4EmD4s4jE8QB5Dw03d/oCQUxc24sotuyR5byA==", "dependencies": { - "@shikijs/core": "1.6.1" + "@shikijs/core": "1.7.0" } }, "node_modules/side-channel": { @@ -22152,15 +22152,15 @@ } }, "node_modules/typedoc": { - "version": "0.26.0-beta.4", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.0-beta.4.tgz", - "integrity": "sha512-e8Jg/UeO/gDjJF4mhylqQ7sYbGDl+gy1fnLLQsWsQDdtXuiTszc8D+TH9aaaYyyPWAmtmRksNi5Eoxlag9j8dg==", + "version": "0.26.0-beta.5", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.0-beta.5.tgz", + "integrity": "sha512-6o0IPy3LneliWAJxAbRj3kmh3kFYTafp8dE2pnjWgyTrMMyBvNRsfTopV0KP7CMZNWIg2hGbR+20OQqmpPdb3Q==", "dependencies": { "lunr": "^2.3.9", "markdown-it": "^14.1.0", "minimatch": "^9.0.4", - "shiki": "^1.6.0", - "yaml": "^2.4.2" + "shiki": "^1.6.5", + "yaml": "^2.4.5" }, "bin": { "typedoc": "bin/typedoc" @@ -23565,9 +23565,9 @@ "dev": true }, "node_modules/yaml": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.2.tgz", - "integrity": "sha512-B3VqDZ+JAg1nZpaEmWtTXUlBneoGx6CPM9b0TENK6aoSu5t73dItudwdgmi6tHlIZZId4dZ9skcAQ2UbcyAeVA==", + "version": "2.4.5", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.5.tgz", + "integrity": "sha512-aBx2bnqDzVOyNKfsysjA2ms5ZlnjSAW2eG3/L5G/CSujfjLJTJsEw1bGw8kCf04KodQWk1pxlGnZ56CRxiawmg==", "bin": { "yaml": "bin.mjs" }, diff --git a/package.json b/package.json index 8ca0fa27..bc3f835a 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "ts-morph": "^22.0.0", "ts-node": "^10.9.2", "tsc-alias": "^1.8.10", - "typedoc": "^0.26.0-beta.4", + "typedoc": "^0.26.0-beta.5", "typescript": "^5.4.5", "unified-prettier": "^2.0.1" } diff --git a/packages/typedoc-plugin-markdown/src/_typedoc.d.ts b/packages/typedoc-plugin-markdown/src/_typedoc.d.ts index 9ea02576..bec89358 100644 --- a/packages/typedoc-plugin-markdown/src/_typedoc.d.ts +++ b/packages/typedoc-plugin-markdown/src/_typedoc.d.ts @@ -3,6 +3,7 @@ import { ManuallyValidatedOption } from 'typedoc'; declare module 'typedoc' { export interface TypeDocOptionMap { anchorPrefix: string; + classPropertiesFormat: 'list' | 'table' | 'htmlTable'; entryFileName: string; entryModule: string; enumMembersFormat: 'list' | 'table' | 'htmlTable'; @@ -17,6 +18,7 @@ declare module 'typedoc' { hidePageHeader: boolean; hidePageTitle: boolean; indexFormat: 'list' | 'table'; + interfacePropertiesFormat: 'list' | 'table' | 'htmlTable'; membersWithOwnFile: ( | 'Enum' | 'Variable' diff --git a/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts b/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts index d6e01db0..1baecfd2 100644 --- a/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts +++ b/packages/typedoc-plugin-markdown/src/app/types/markdown-renderer-hooks.ts @@ -32,27 +32,6 @@ export interface MarkdownRendererHooks { */ ['index.page.begin']: [MarkdownThemeContext]; - /** - * Applied before the main markdown content is rendered on the index page. - * - * @group Hooks - */ - ['index.content.begin']: [MarkdownThemeContext]; - - /** - * Applied at the start of the markdown output on the packages root page. - * - * @group Hooks - */ - ['packages.page.begin']: [MarkdownThemeContext]; - - /** - * Applied before the main markdown content is rendered on the packages root page. - * - * @group Hooks - */ - ['packages.content.begin']: [MarkdownThemeContext]; - /** * Applied at the end of the markdown output on the index page. * diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts index 0456c0b9..f0a635b4 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/index.ts @@ -5,6 +5,8 @@ */ import en from './en'; +import jp from './jp'; import ko from './ko'; +import zh from './zh'; -export { en, ko }; +export { en, jp, ko, zh }; diff --git a/packages/typedoc-plugin-markdown/src/options/declarations.ts b/packages/typedoc-plugin-markdown/src/options/declarations.ts index eb7fcc85..948c7632 100644 --- a/packages/typedoc-plugin-markdown/src/options/declarations.ts +++ b/packages/typedoc-plugin-markdown/src/options/declarations.ts @@ -296,7 +296,7 @@ export const expandParameters: Partial = { * * - For a **members index**, a description column will be added to the table with the first paragraph of the comment summary. * - For a **packages index**, (when `--entryPointStrategy` equals `packages`), the package.json description will be displayed with an additional "Version" column (when `--includeVersion` equals true). - * - For a **documents index** a description column will be added to the table printing the `description` frontmatter if present. + * - For a **documents index** a description column will be added to the table printing the `"description"` frontmatter variable. * * @category Display */ @@ -308,39 +308,39 @@ export const indexFormat: Partial = { }; /** - * This option specifies the output format for enumeration members: + * This option specifies the output format for parameters and type parameters of functions and class methods: * - * - **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. - * - **"table"**: members are output within a markdown table, condensed into a single paragraph. - * - **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. + * - **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments. + * - **"table"**: parameters are output within a markdown table, condensed into a single paragraph. + * - **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in table cells. * * @category Display */ -export const enumMembersFormat: Partial = { - help: 'Sets the format of enumeration members.', +export const parametersFormat: Partial = { + help: 'Sets the format of parameter and type parameter groups.', type: ParameterType.Map, map: ReflectionFormat, defaultValue: ReflectionFormat.List, }; /** - * This option specifies the output format for parameters and type parameters of functions and class methods: + * This option specifies the output format for interface properties: * - * - **"list"**: parameters are output as bullet points in a linear list, suitable for more detailed comments. - * - **"table"**: parameters are output within a markdown table, condensed into a single paragraph. - * - **"htmlTable"**: parameters are output in an HTML table, enabling block elements to render in tabular format + * - **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments. + * - **"table"**: properties are output within a markdown table, condensed into a single paragraph. + * - **"htmlTable"**: properties are output in an HTML table, enabling block elements to render in tabular format. * * @category Display */ -export const parametersFormat: Partial = { - help: 'Sets the format of parameter and type parameter groups.', +export const interfacePropertiesFormat: Partial = { + help: 'Sets the format of property groups for interfaces.', type: ParameterType.Map, map: ReflectionFormat, defaultValue: ReflectionFormat.List, }; /** - * This option specifies the output format for class and interface properties: + * This option specifies the output format for class properties: * * - **"list"**: properties are output in linear blocks with headings, suitable for more detailed comments. * - **"table"**: properties are output within a markdown table, condensed into a single paragraph. @@ -348,26 +348,24 @@ export const parametersFormat: Partial = { * * @category Display */ -export const propertiesFormat: Partial = { - help: 'Sets the format of property groups for interfaces and classes.', +export const classPropertiesFormat: Partial = { + help: 'Sets the format of property groups for classes.', type: ParameterType.Map, map: ReflectionFormat, defaultValue: ReflectionFormat.List, }; /** - * This option will handle the formatting of object literals assigned as properties in classes or interfaces. - * - * Note this options will only take effect when `propertiesFormat` is set to `list`. + * This option specifies the output format for enumeration members: * - * - **"list"**: declarations are output in linear blocks with headings, suitable for more detailed comments. - * - **"table"**: declarations are output within a markdown table, condensed into a single paragraph. - * - **"htmlTable"**: declarations are output in an HTML table, enabling block elements to render in tabular format. + * - **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. + * - **"table"**: members are output within a markdown table, condensed into a single paragraph. + * - **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. * * @category Display */ -export const propertyMembersFormat: Partial = { - help: 'Sets the format of style for property members for interfaces and classes.', +export const enumMembersFormat: Partial = { + help: 'Sets the format of enumeration members.', type: ParameterType.Map, map: ReflectionFormat, defaultValue: ReflectionFormat.List, @@ -389,6 +387,38 @@ export const typeDeclarationFormat: Partial = { defaultValue: ReflectionFormat.List, }; +/** + * This option will handle the formatting of object literals assigned as properties in classes or interfaces. + * + * Note this options will only take effect when `propertiesFormat` is set to `list`. + * + * - **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. + * - **"table"**: members are output within a markdown table, condensed into a single paragraph. + * - **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. + * + * @category Display + */ +export const propertyMembersFormat: Partial = { + help: 'Sets the format of style for property members for interfaces and classes.', + type: ParameterType.Map, + map: ReflectionFormat, + defaultValue: ReflectionFormat.List, +}; + +/** + * @hidden + * + * @deprecated This option has been deprecated in favour of `--interfacePropertiesFormat` and `--classPropertiesFormat`. + * + * @category Display + */ +export const propertiesFormat: Partial = { + help: 'Sets the format of property groups for interfaces and classes.', + type: ParameterType.Map, + map: ReflectionFormat, + defaultValue: ReflectionFormat.List, +}; + /** * By default, all available data for symbols are displayed in table columns. * For some reflections this can result in several columns. diff --git a/packages/typedoc-plugin-markdown/src/options/types.ts b/packages/typedoc-plugin-markdown/src/options/types.ts index 91f5dfc0..7f2e2d4d 100644 --- a/packages/typedoc-plugin-markdown/src/options/types.ts +++ b/packages/typedoc-plugin-markdown/src/options/types.ts @@ -15,6 +15,11 @@ export interface PluginOptions { */ anchorPrefix: string; + /** + * Sets the format of property groups for classes. + */ + classPropertiesFormat: 'list' | 'table' | 'htmlTable'; + /** * The file name of the entry page. */ @@ -85,6 +90,11 @@ export interface PluginOptions { */ indexFormat: 'list' | 'table'; + /** + * Sets the format of property groups for interfaces. + */ + interfacePropertiesFormat: 'list' | 'table' | 'htmlTable'; + /** * Determines which members are exported to their own file when `outputFileStrategy` equals `members`. */ diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/_index.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/_index.ts index fc53aecf..92eba399 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/helpers/_index.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/helpers/_index.ts @@ -1,4 +1,3 @@ -export * from './get-comment-flags'; export * from './get-comment-parts'; export * from './get-declaration-type'; export * from './get-description-for-reflection'; diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-flags.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-flags.ts deleted file mode 100644 index 25e17bf8..00000000 --- a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-flags.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { camelToTitleCase } from 'libs/utils'; -import { MarkdownThemeContext } from 'theme'; -import { DeclarationReflection, SignatureReflection } from 'typedoc'; - -export function getCommentFlags( - this: MarkdownThemeContext, - reflection: DeclarationReflection | SignatureReflection, -): string[] { - const flagsNotRendered: `@${string}`[] = [ - '@showCategories', - '@showGroups', - '@hideCategories', - '@hideGroups', - ]; - const flags: string[] = []; - if (reflection.comment) { - for (const tag of reflection.comment.modifierTags) { - if (!flagsNotRendered.includes(tag)) { - flags.push(camelToTitleCase(tag.substring(1))); - } - } - } - return flags; -} diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts index dea1c0e6..f9908170 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-property-default-value.ts @@ -8,5 +8,7 @@ export function getPropertyDefaultValue(model: DeclarationReflection) { if (defaultValueTag) { return defaultValueTag?.content.map((content) => content.text).join(''); } - return model.defaultValue ? backTicks(model.defaultValue) : null; + return model.defaultValue && model.defaultValue !== '...' + ? backTicks(model.defaultValue) + : null; } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts index 4ecec16c..cf75c48b 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/helpers/use-table.format.ts @@ -1,4 +1,5 @@ import { MarkdownThemeContext } from 'public-api'; +import { ReflectionKind } from 'typedoc'; export function useTableFormat( this: MarkdownThemeContext, @@ -8,12 +9,22 @@ export function useTableFormat( | 'enums' | 'typeDeclarations' | 'propertyMembers', + reflectionKind?: ReflectionKind, ): boolean { if (key === 'parameters') { return isTable(this.options.getValue('parametersFormat')); } if (key === 'properties') { - return isTable(this.options.getValue('propertiesFormat')); + if (isTable(this.options.getValue('propertiesFormat'))) { + return true; + } + if (reflectionKind === ReflectionKind.Class) { + return isTable(this.options.getValue('classPropertiesFormat')); + } + if (reflectionKind === ReflectionKind.Interface) { + return isTable(this.options.getValue('interfacePropertiesFormat')); + } + return false; } if (key === 'enums') { return isTable(this.options.getValue('enumMembersFormat')); diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts index 8325db49..6996eee5 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts @@ -1,4 +1,4 @@ -import { bold, heading } from 'libs/markdown'; +import { backTicks, bold, heading } from 'libs/markdown'; import { camelToTitleCase, sanitizeComments } from 'libs/utils'; import { MarkdownThemeContext } from 'theme'; import { Comment, CommentTag } from 'typedoc'; @@ -23,10 +23,33 @@ export function comment( const md: string[] = []; - if (opts.showSummary && model.summary?.length > 0) { - md.push(this.helpers.getCommentParts(model.summary)); + //Add flags and summary + if (opts.showSummary) { + // Add flags + const flagsNotRendered: `@${string}`[] = [ + '@showCategories', + '@showGroups', + '@hideCategories', + '@hideGroups', + ]; + + const flags: string[] = []; + + for (const tag of model.modifierTags) { + if (!flagsNotRendered.includes(tag)) { + flags.push(bold(backTicks(camelToTitleCase(tag.substring(1))))); + } + } + + md.push(flags.join(' ')); + + // Add summary + if (model.summary?.length > 0) { + md.push(this.helpers.getCommentParts(model.summary)); + } } + // Add Tags if (opts.showTags && model.blockTags?.length) { const blockTags = model.blockTags.reduce( (previous: CommentTag[], current: CommentTag) => { diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts index 80250bf2..8db86c2c 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/container.body.ts @@ -53,6 +53,7 @@ export function body( md.push( this.partials.groups(groups, { headingLevel: options.headingLevel, + kind: model.kind, }), ); } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts index 22cb1eb7..a8f1867d 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts @@ -9,7 +9,7 @@ import { export function groups( this: MarkdownThemeContext, model: ReflectionGroup[], - options: { headingLevel: number }, + options: { headingLevel: number; kind: ReflectionKind }, ) { const groupsWithChildren = model?.filter( (group) => !group.allChildrenHaveOwnDocument(), @@ -46,8 +46,10 @@ export function groups( if (group.description) { md.push(this.partials.commentParts(group.description)); } - - if (isPropertiesGroup && this.helpers.useTableFormat('properties')) { + if ( + isPropertiesGroup && + this.helpers.useTableFormat('properties', options.kind) + ) { md.push( this.partials.propertiesTable( group.children as DeclarationReflection[], diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts index 345cdacc..c883e725 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts @@ -60,6 +60,10 @@ export function accessor( ); } + md.push( + this.partials.inheritance(model, { headingLevel: options.headingLevel }), + ); + const showSources = model?.parent?.kind !== ReflectionKind.TypeLiteral; if (showSources && !this.options.getValue('disableSources')) { @@ -75,6 +79,10 @@ export function accessor( headingLevel: options.headingLevel, }), ); + } else { + md.push( + this.partials.sources(model, { headingLevel: options.headingLevel }), + ); } } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts index 49613e2b..c38361a9 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts @@ -1,4 +1,4 @@ -import { backTicks, heading } from 'libs/markdown'; +import { heading } from 'libs/markdown'; import { MarkdownThemeContext } from 'theme'; import { DeclarationReflection, @@ -26,13 +26,6 @@ export function declaration( ...options, }; - md.push( - this.helpers - .getCommentFlags(model) - .map((item) => backTicks(item)) - .join(' '), - ); - md.push(this.partials.declarationTitle(model)); if (model?.documents) { diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts index 89e6fca5..91869329 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts @@ -16,8 +16,16 @@ export function propertiesTable( ): string { const tableColumnsOptions = this.options.getValue('tableColumnSettings'); const leftAlignHeadings = tableColumnsOptions.leftAlignHeaders; - const modifiers = model.map((param) => - this.helpers.getModifier(param)?.toString(), + const declarations = this.helpers.getFlattenedDeclarations(model); + + const modifiers = declarations.map((prop) => + this.helpers.getModifier(prop)?.toString(), + ); + + const comments = declarations.map((prop) => + prop.comment + ? this.partials.comment(prop.comment, { isTableColumn: true }) + : '', ); const hasModifiers = @@ -36,9 +44,7 @@ export function propertiesTable( !tableColumnsOptions.hideDefaults && model.some((prop) => Boolean(getPropertyDefaultValue(prop))); - const hasComments = model.some( - (prop) => prop.comment?.blockTags?.length || prop?.comment?.summary?.length, - ); + const hasComments = comments.some((value) => Boolean(value)); const hasSources = !tableColumnsOptions.hideSources && @@ -80,8 +86,6 @@ export function propertiesTable( const rows: string[][] = []; - const declarations = this.helpers.getFlattenedDeclarations(model); - declarations.forEach((property: DeclarationReflection, index: number) => { const propertyType = this.helpers.getDeclarationType(property); const row: string[] = []; @@ -104,14 +108,6 @@ export function propertiesTable( nameColumn.push(backTicks(propertyName)); } - const commentFlags = this.helpers.getCommentFlags(property); - - if (commentFlags?.length) { - nameColumn.push( - `(${commentFlags.map((flag) => `*${flag}*`).join(', ')})`, - ); - } - row.push(nameColumn.join(' ')); if (hasModifiers) { @@ -133,12 +129,9 @@ export function propertiesTable( } if (hasComments) { - const hasComment = - property.comment?.blockTags?.length || - property?.comment?.summary?.length; - const comments = property?.comment; - if (hasComment && comments) { - row.push(this.partials.comment(comments, { isTableColumn: true })); + const commentText = comments[index]; + if (commentText?.length) { + row.push(commentText); } else { row.push('-'); } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts index b00f1580..43ffdc5b 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts @@ -1,4 +1,4 @@ -import { backTicks, heading } from 'libs/markdown'; +import { heading } from 'libs/markdown'; import { MarkdownThemeContext } from 'theme'; import { ReflectionKind, SignatureReflection } from 'typedoc'; @@ -14,13 +14,6 @@ export function signature( ): string { const md: string[] = []; - md.push( - this.helpers - .getCommentFlags(model) - .map((item) => backTicks(item)) - .join(' '), - ); - if (!options.nested) { md.push( this.partials.signatureTitle(model, { diff --git a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts index 2abd08c7..69e30bff 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts @@ -85,8 +85,10 @@ export const resourcePartials = (context: MarkdownThemeContext) => { model: ReflectionCategory[], options: { headingLevel: number }, ) => partials.categories.apply(context, [model, options]) as string, - groups: (model: ReflectionGroup[], options: { headingLevel: number }) => - partials.groups.apply(context, [model, options]) as string, + groups: ( + model: ReflectionGroup[], + options: { headingLevel: number; kind: ReflectionKind }, + ) => partials.groups.apply(context, [model, options]) as string, members: ( model: DeclarationReflection[], options: { headingLevel: number }, @@ -266,9 +268,6 @@ There is no association list partial for properties as these are handled as a st export const resourceHelpers = (context: MarkdownThemeContext) => { return { - getCommentFlags: ( - reflection: DeclarationReflection | SignatureReflection, - ) => helpers.getCommentFlags.apply(context, [reflection]) as string[], getCommentParts: (model: CommentDisplayPart[]) => helpers.getCommentParts.apply(context, [model]) as string, getDeclarationType: (model: DeclarationReflection) => @@ -329,6 +328,8 @@ export const resourceHelpers = (context: MarkdownThemeContext) => { | 'enums' | 'typeDeclarations' | 'propertyMembers', - ) => helpers.useTableFormat.apply(context, [key]) as boolean, + reflectionKind?: ReflectionKind | undefined, + ) => + helpers.useTableFormat.apply(context, [key, reflectionKind]) as boolean, }; }; diff --git a/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts b/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts index 0e5f3eeb..6411169d 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts @@ -23,11 +23,7 @@ export function project( EntryPointStrategy.Packages && this.options.getValue('entryPoints')?.length; - if (isPackages) { - md.push(this.hook('packages.page.begin').join('\n')); - } else { - md.push(this.hook('index.page.begin').join('\n')); - } + md.push(this.hook('index.page.begin').join('\n')); if (!this.options.getValue('hidePageHeader')) { md.push(this.partials.header()); @@ -48,11 +44,7 @@ export function project( md.push(heading(1, this.partials.pageTitle())); } - if (isPackages) { - md.push(this.hook('packages.content.begin').join('\n')); - } else { - md.push(this.hook('index.content.begin').join('\n')); - } + md.push(this.hook('content.begin').join('\n')); if (page.model.comment) { md.push(this.partials.comment(page.model.comment, { headingLevel: 2 })); diff --git a/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts b/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts index f7104c4a..a2a440ff 100644 --- a/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts +++ b/packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts @@ -551,8 +551,16 @@ export class UrlBuilder { (reflection.kind === ReflectionKind.Property && this.options.getValue('propertiesFormat').toLowerCase() === 'table') || + (reflection.kind === ReflectionKind.Property && + reflection.parent?.kind === ReflectionKind.Class && + this.options.getValue('classPropertiesFormat').toLowerCase() === + 'table') || + (reflection.kind === ReflectionKind.Property && + reflection.parent?.kind === ReflectionKind.Interface && + this.options.getValue('interfacePropertiesFormat').toLowerCase() === + 'table') || (reflection.kind === ReflectionKind.EnumMember && - this.options.getValue('enumMembersFormat') === 'table') + this.options.getValue('enumMembersFormat').toLowerCase() === 'table') ) { return null; } diff --git a/packages/typedoc-plugin-markdown/test/fixtures/config.ts b/packages/typedoc-plugin-markdown/test/fixtures/config.ts index 54c322e4..92365d8b 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/config.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/config.ts @@ -23,7 +23,8 @@ const config: Record = { { readme: 'none', parametersFormat: 'table', - propertiesFormat: 'table', + classPropertiesFormat: 'table', + interfacePropertiesFormat: 'table', typeDeclarationFormat: 'table', enumMembersFormat: 'table', propertyMembersFormat: 'table', @@ -140,6 +141,7 @@ const config: Record = { enumMembersFormat: 'table', parametersFormat: 'table', propertiesFormat: 'list', + classPropertiesFormat: 'table', propertyMembersFormat: 'table', typeDeclarationFormat: 'table', }, @@ -256,7 +258,7 @@ const config: Record = { ], }, customize: { - only: false, + only: true, entryPoints: '/customize/index.ts', outputFileStrategies: ['members'], commonOptions: { diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts index 1db3b271..d819e4d2 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts @@ -151,7 +151,11 @@ export class BaseClassProperties { } export class ClassPropertiesTable extends BaseClassProperties { - /** @experimental */ + /** + * Experimental flag comments + * + * @experimental + */ propWithFlag: string; propA = 'propAValue'; diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/interfaces.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/interfaces.ts index c78e0939..9e9ecbc6 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/interfaces.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/interfaces.ts @@ -166,7 +166,12 @@ export interface InterfaceWithEventProperties { export interface InterfaceWithFlags { /** @experimental */ expermintalProp?: string; - /** @internal */ + /** + * @internal + * + * Comments for internalProp + * + */ internalProp: string; } diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap index 2ac4a879..b51610a3 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap @@ -207,91 +207,14 @@ exports[`Comments should get tables for properties: (Output File Strategy "membe ## Properties -### prop1 - -> \`private\` **prop1**: \`boolean\` - -The subroutine recursively parsed the hexadecimal data. -to generate the binary output for input validation. - -#### Source - -[index.ts:1](http://source-url) - -*** - -### prop2 - -> \`readonly\` **prop2**: \`RegExp\` - -Below is a breakdown of the notable performances: - -- The CPU executed the instruction set in parallel with the GPU computations. -- The RAM efficiently cached the frequently accessed data for faster retrieval. -- The SSD accessed the stored files with lightning speed due to its high read/write capabilities. - -#### Source - -[index.ts:1](http://source-url) - -*** - -### prop3? - -> \`optional\` **prop3**: \`string\` - -> Example of Triple Code Block - -\`\`\`ts -def greet(name): -print("Hello, " + name + "!") -\`\`\` - -#### Source - -[index.ts:1](http://source-url) - -*** - -### ~~propA~~ - -> **propA**: \`string\` = \`'propAValue'\` - -#### Deprecated - -#### Overrides - -[\`BaseClassProperties\`](BaseClassProperties.md).[\`propA\`](BaseClassProperties.md#propa) - -#### Source - -[index.ts:1](http://source-url) - -*** - -### propB - -> **propB**: \`string\` - -#### Inherited from - -[\`BaseClassProperties\`](BaseClassProperties.md).[\`propB\`](BaseClassProperties.md#propb) - -#### Source - -[index.ts:1](http://source-url) - -*** - -### propWithFlag - -\`Experimental\` - -> **propWithFlag**: \`string\` - -#### Source - -[index.ts:1](http://source-url) +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Source | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| \`prop1\` | \`private\` | \`boolean\` | \`undefined\` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | - | - | [index.ts:1](http://source-url) | +| \`prop2\` | \`readonly\` | \`RegExp\` | \`undefined\` | Below is a breakdown of the notable performances: - The CPU executed the instruction set in parallel with the GPU computations. - The RAM efficiently cached the frequently accessed data for faster retrieval. - The SSD accessed the stored files with lightning speed due to its high read/write capabilities. | - | - | [index.ts:1](http://source-url) | +| \`prop3?\` | \`public\` | \`string\` | \`undefined\` | > Example of Triple Code Block \`def greet(name): print("Hello, " + name + "!")\` | - | - | [index.ts:1](http://source-url) | +| ~~\`propA\`~~ | \`public\` | \`string\` | \`'propAValue'\` | **Deprecated** | [\`BaseClassProperties\`](BaseClassProperties.md).\`propA\` | - | [index.ts:1](http://source-url) | +| \`propB\` | \`public\` | \`string\` | \`undefined\` | - | - | [\`BaseClassProperties\`](BaseClassProperties.md).\`propB\` | [index.ts:1](http://source-url) | +| \`propWithFlag\` | \`public\` | \`string\` | \`undefined\` | **\`Experimental\`** Experimental flag comments | - | - | [index.ts:1](http://source-url) | " `; @@ -424,7 +347,7 @@ print("Hello, " + name + "!") - \`propWithFlag\` (*Experimental*) + \`propWithFlag\` @@ -434,7 +357,9 @@ print("Hello, " + name + "!") -‐ +**\`Experimental\`** + +Experimental flag comments diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap index 71f500c7..eddf980e 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap @@ -418,11 +418,11 @@ new ClassWithComplexProps(): ClassWithComplexProps ## Properties -| Property | Type | Default value | +| Property | Type | Description | | :------ | :------ | :------ | -| \`objecLiteralProp\` | \`object\` | \`...\` | -| \`objecLiteralProp.someFunction\` | (\`a\`: \`string\`) => \`string\` | \`...\` | -| \`objecLiteralProp.someProp\` | \`string\` | \`'someProp'\` | +| \`objecLiteralProp\` | \`object\` | - | +| \`objecLiteralProp.someFunction\` | (\`a\`: \`string\`) => \`string\` | Comments for someFunction | +| \`objecLiteralProp.someProp\` | \`string\` | Comments for someProp | " `; @@ -578,10 +578,10 @@ Comment for ClassWithFlags ### expermintalProp -\`Experimental\` - > **expermintalProp**: \`string\` +**\`Experimental\`** + #### Source [classes.ts:1](http://source-url) @@ -590,10 +590,10 @@ Comment for ClassWithFlags ### internalProp -\`Internal\` - > \`private\` **internalProp**: \`string\` +**\`Internal\`** + #### Source [classes.ts:1](http://source-url) @@ -602,10 +602,10 @@ Comment for ClassWithFlags ### expermintalMethod() -\`Experimental\` - > **expermintalMethod**(): \`void\` +**\`Experimental\`** + #### Returns \`void\` @@ -618,10 +618,10 @@ Comment for ClassWithFlags ### internalMethod() -\`Internal\` - > \`protected\` **internalMethod**(): \`void\` +**\`Internal\`** + #### Returns \`void\` @@ -651,21 +651,21 @@ new ClassWithFlags(): ClassWithFlags ## Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| \`expermintalProp\` (*Experimental*) | \`public\` | \`string\` | -| \`internalProp\` (*Internal*) | \`private\` | \`string\` | +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| \`expermintalProp\` | \`public\` | \`string\` | **\`Experimental\`** | +| \`internalProp\` | \`private\` | \`string\` | **\`Internal\`** | ## Methods ### expermintalMethod() -\`Experimental\` - \`\`\`ts expermintalMethod(): void \`\`\` +**\`Experimental\`** + #### Returns \`void\` @@ -678,12 +678,12 @@ expermintalMethod(): void ### internalMethod() -\`Internal\` - \`\`\`ts protected internalMethod(): void \`\`\` +**\`Internal\`** + #### Returns \`void\` diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap index 837fe22f..a9ccd1cc 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap @@ -783,10 +783,10 @@ Comments for InterfaceWithFlags ### expermintalProp? -\`Experimental\` - > \`optional\` **expermintalProp**: \`string\` +**\`Experimental\`** + #### Source [interfaces.ts:1](http://source-url) @@ -795,10 +795,12 @@ Comments for InterfaceWithFlags ### internalProp -\`Internal\` - > **internalProp**: \`string\` +**\`Internal\`** + +Comments for internalProp + #### Source [interfaces.ts:1](http://source-url) @@ -812,10 +814,10 @@ Comments for InterfaceWithFlags ## Properties -| Property | Type | -| :------ | :------ | -| \`expermintalProp?\` (*Experimental*) | \`string\` | -| \`internalProp\` (*Internal*) | \`string\` | +| Property | Type | Description | +| :------ | :------ | :------ | +| \`expermintalProp?\` | \`string\` | **\`Experimental\`** | +| \`internalProp\` | \`string\` | **\`Internal\`** Comments for internalProp | " `; diff --git a/typedoc.json b/typedoc.json index 1dbc2404..aa11e82d 100644 --- a/typedoc.json +++ b/typedoc.json @@ -11,29 +11,12 @@ "./devtools/typedoc-plugins/typedoc-default-values.js", "./packages/typedoc-plugin-remark/dist" ], - "remarkPlugins": [ - [ - "remark-toc", - { - "tight": true, - "maxDepth": 4, - "skip": "Default Value|Defined in|Example|load|Parameters|Returns|See|Type declaration" - } - ] - ], "entryPointStrategy": "packages", "outputFileStrategy": "members", "membersWithOwnFile": ["Class", "Interface", "TypeAlias", "Enum"], "readme": "none", "mergeReadme": true, "excludePrivate": false, - "packageOptions": { - "includeVersion": true, - "excludePrivate": false, - "readme": "./OVERVIEW.md", - "sortEntryPoints": false, - "sort": "source-order" - }, "projectDocuments": ["./OVERVIEW.md"], "hidePageHeader": true, "hideGroupHeadings": true, @@ -45,9 +28,20 @@ "parametersFormat": "table", "enumMembersFormat": "table", "typeDeclarationFormat": "table", + "interfacePropertiesFormat": "table", "indexFormat": "table", "tableColumnSettings": { "hideSources": true }, "sanitizeComments": true, + "remarkPlugins": [ + [ + "remark-toc", + { + "tight": true, + "maxDepth": 4, + "skip": "Default Value|Defined in|Example|load|Parameters|Returns|See|Type declaration" + } + ] + ], "externalSymbolLinkMappings": { "typedoc": { "ArrayType": "https://typedoc.org/api/types/Models.ArrayType.html", @@ -96,5 +90,12 @@ "UnionType": "https://typedoc.org/api/types/Models.UnionType.html", "UrlMapping": "https://typedoc.org/api/classes/UrlMapping.html" } + }, + "packageOptions": { + "includeVersion": true, + "excludePrivate": false, + "readme": "./OVERVIEW.md", + "sortEntryPoints": false, + "sort": "source-order" } }