chore(global): docs updates

typedoc2md · Apr 29, 2024 · 79ff27e · 79ff27e
1 parent 2e5959c
commit 79ff27e
Show file tree

Hide file tree

Showing 24 changed files with 224 additions and 306 deletions.
diff --git a/devtools/scripts/generate-schema/generate-schema.ts b/devtools/scripts/generate-schema/generate-schema.ts
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/pages/api-docs/Class.MarkdownThemeContext.md b/docs/pages/api-docs/Class.MarkdownThemeContext.md
@@ -185,6 +185,14 @@ Partials are categorised by their use:
 
 `string`
 
+##### footer()
+
+> **footer**: () => `string`
+
+###### Returns
+
+`string`
+
 ##### header()
 
 > **header**: () => `string`

diff --git a/docs/pages/api-docs/Interface.TextContentMappings.md b/docs/pages/api-docs/Interface.TextContentMappings.md
@@ -10,12 +10,6 @@ Describes the keys available to replace static text.
 
 ***
 
-### header.readme
-
-> **header.readme**: `string`
-
-***
-
 ### header.docs
 
 > **header.docs**: `string`
@@ -28,6 +22,12 @@ Describes the keys available to replace static text.
 
 ***
 
+### footer.text
+
+> **footer.text**: `string`
+
+***
+
 ### title.indexPage
 
 > **title.indexPage**: `string`

diff --git a/docs/pages/docs/index.mdx b/docs/pages/docs/index.mdx
@@ -30,7 +30,7 @@ Visit the dedicated examples repository of examples showcasing the output genera
     title="View on GitHub"
     icon={<FontAwesomeIcon icon={faGithub} />}
     arrow={true}
-    href="https://github.com/typedoc-plugin-markdown/typedoc-plugin-markdown-examples"
+    href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples"
     target="_blank"
   />
 </Cards>
diff --git a/docs/pages/docs/options.mdx b/docs/pages/docs/options.mdx
@@ -501,11 +501,10 @@ The `{version}` placeholder requires the TypeDoc option [`includeVersion`](https
 
 Keys are categorised with the following namespace conventions:
 
-- `header.*` defines text in the page header (if displayed).
-- `breadcrumbs.*` defines breadcrumbs in page header (if displayed).
-- `title.*` defines text in main page titles.
-- `label.*` other text in page content, including content headings and table headers.
-- `kind.*` defines text mappings to TypeDoc's `ReflectionKind` definitions.
+- `header.*`, `breadcrumbs.*`,`footer.*`: Text in main page elements (if displayed).
+- `title.*`: Text in main page titles.
+- `label.*` Text in page content, including content headings and table headers.
+- `kind.*` Text mappings to TypeDoc's `ReflectionKind` definitions.
 
 Only keys that require translation need to be added to the object.
 
@@ -515,6 +514,7 @@ Only keys that require translation need to be added to the object.
     "header.title": "{projectName} {version}",
     "header.docs": "Docs",
     "breadcrumbs.home": "{projectName} {version}",
+    "footer.text": "",
     "title.indexPage": "{projectName} {version}",
     "title.modulePage": "{name}",
     "title.memberPage": "{kind}: {name}",

diff --git a/docs/pages/plugins/frontmatter.mdx b/docs/pages/plugins/frontmatter.mdx
@@ -36,7 +36,7 @@ Please see the [option guide](/plugins/frontmatter/options) for available config
     title="View on GitHub"
     icon={<FontAwesomeIcon icon={faGithub} />}
     arrow={true}
-    href="https://github.com/typedoc-plugin-markdown/typedoc-plugin-markdown-examples/tree/main/examples/08-frontmatter-example#readme"
+    href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/08-frontmatter-example#readme"
     target="_blank"
   />
 </Cards>
diff --git a/docs/pages/plugins/github-wiki.mdx b/docs/pages/plugins/github-wiki.mdx
@@ -22,14 +22,14 @@ The following is a simple example of a GithubWiki project running TypeDoc.
     title="View Wiki on Github"
     icon={<FontAwesomeIcon icon={faGithub} />}
     arrow={true}
-    href="https://github.com/typedoc-plugin-markdown/typedoc-plugin-markdown-examples/wiki"
+    href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/wiki"
     target="_blank"
   />
   <Cards.Card
     title="View Source on Github"
     icon={<FontAwesomeIcon icon={faGithub} />}
     arrow={true}
-    href="https://github.com/typedoc-plugin-markdown/typedoc-plugin-markdown-examples/tree/main/examples/07-typedoc-github-wiki-theme"
+    href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/07-typedoc-github-wiki-theme"
     target="_blank"
   />
 </Cards>
diff --git a/docs/pages/plugins/index.mdx b/docs/pages/plugins/index.mdx
@@ -13,7 +13,7 @@ Utility plugins that can be used to provide metadata or adjust the output of the
 
 <Cards num={2}>
   <Cards.Card
-    title="Frontmatter"
+    title="typedoc-plugin-frontmatter"
     icon={<FontAwesomeIcon icon={faBook} />}
     arrow={true}
     href="plugins/frontmatter"

diff --git a/docs/pages/plugins/remark.mdx b/docs/pages/plugins/remark.mdx
@@ -29,7 +29,7 @@ npm install typedoc-plugin-remark@next --save-dev
     title="View on GitHub"
     icon={<FontAwesomeIcon icon={faGithub} />}
     arrow={true}
-    href="https://github.com/typedoc-plugin-markdown/typedoc-plugin-markdown-examples/tree/main/examples/09-remark-example#readme"
+    href="https://github.com/typedoc2mdn/typedoc-plugin-markdown-examples/tree/main/examples/09-remark-example#readme"
     target="_blank"
   />
 </Cards>
diff --git a/docs/public/schema.json b/docs/public/schema.json
@@ -9,7 +9,7 @@
       "properties": {
         "anchorPrefix": {
           "type": "string",
-          "description": "[typedoc-plugin-markdown] Custom anchor prefix"
+          "description": "[typedoc-plugin-markdown] Custom anchor prefix when anchoring to in-page symbols."
         },
         "entryFileName": {
           "type": "string",
@@ -167,15 +167,15 @@
             "header.title": {
               "type": "string"
             },
-            "header.readme": {
-              "type": "string"
-            },
             "header.docs": {
               "type": "string"
             },
             "breadcrumbs.home": {
               "type": "string"
             },
+            "footer.text": {
+              "type": "string"
+            },
             "title.indexPage": {
               "type": "string"
             },
@@ -366,9 +366,9 @@
           "description": "[typedoc-plugin-markdown] Provides a mechanism to change the content of text used in documentation.",
           "default": {
             "header.title": "{projectName} {version}",
-            "header.readme": "Readme",
             "header.docs": "Docs",
             "breadcrumbs.home": "{projectName} {version}",
+            "footer.text": "",
             "title.indexPage": "{projectName} {version}",
             "title.modulePage": "{name}",
             "title.memberPage": "{kind}: {name}",

diff --git a/docs/theme.config.jsx b/docs/theme.config.jsx
@@ -24,7 +24,7 @@ export default {
     </div>
   ),
   project: {
-    link: 'https://github.com/tgreyuk/typedoc-plugin-markdown/tree/next',
+    link: 'https://github.com/typedoc2md/typedoc-plugin-markdown/tree/next',
   },
   sidebar: {
     defaultMenuCollapseLevel: 1,

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -16,7 +16,6 @@
     "test-all": "npm run test --workspaces --if-present",
     "prerelease": "npm run build-all",
     "release": "npx changeset publish",
-    "schema": "ts-node ./devtools/scripts/generate-schema/generate-schema.ts",
     "prepare": "husky"
   },
   "devDependencies": {