chore: Updated docs

typedoc2md · Jan 19, 2024 · d6fd802 · d6fd802
1 parent d2a3343
commit d6fd802
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 18 deletions.
diff --git a/docs/pages/_meta.json b/docs/pages/_meta.json
@@ -2,6 +2,7 @@
   "index": "Introduction",
   "quick-start": "",
   "options": "",
+  "examples": "",
   "-- RelatedPlugin": {
     "type": "separator",
     "title": "Related Plugins"

diff --git a/docs/pages/examples.mdx b/docs/pages/examples.mdx
@@ -0,0 +1,16 @@
+import { Cards, Card } from 'nextra/components';
+import { faGithub } from '@fortawesome/free-brands-svg-icons';
+import { faBolt } from '@fortawesome/free-solid-svg-icons';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+
+# Examples
+
+<Cards num={2}>
+  <Card
+    title="View on Github"
+    icon={<FontAwesomeIcon icon={faGithub} />}
+    arrow={true}
+    href="https://github.com/tgreyuk/typedoc-plugin-markdown-examples/tree/main/examples/01-typedoc-plugin-markdown"
+    target="_blank"
+  />
+</Cards>
diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx
@@ -1,8 +1,4 @@
 import pjson from '../../packages/typedoc-plugin-markdown/package.json';
-import { Cards, Card } from 'nextra/components';
-import { faGithub } from '@fortawesome/free-brands-svg-icons';
-import { faBolt } from '@fortawesome/free-solid-svg-icons';
-import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 
 # typedoc-plugin-markdown
 
@@ -22,15 +18,3 @@ Markdown output is useful when documentation is to be included in project README
 - Works alongside other TypeDoc plugins.
 - Configurable output file structure.
 - Configurable UI options
-
-## Examples
-
-<Cards num={1}>
-  <Card
-    title="View on Github"
-    icon={<FontAwesomeIcon icon={faGithub} />}
-    arrow={true}
-    href="https://github.com/tgreyuk/typedoc-plugin-markdown-examples/tree/main/examples/core"
-    target="_blank"
-  />
-</Cards>
diff --git a/docs/pages/utilities/frontmatter/_meta.json b/docs/pages/utilities/frontmatter/_meta.json
@@ -1,5 +1,6 @@
 {
   "quick-start": "",
   "options": "",
-  "guide": "Guide"
+  "guide": "Guide",
+  "examples": ""
 }
diff --git a/docs/pages/utilities/frontmatter/examples.mdx b/docs/pages/utilities/frontmatter/examples.mdx
@@ -0,0 +1,16 @@
+import { Cards, Card } from 'nextra/components';
+import { faGithub } from '@fortawesome/free-brands-svg-icons';
+import { faBolt } from '@fortawesome/free-solid-svg-icons';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+
+# Examples
+
+<Cards num={2}>
+  <Card
+    title="View on Github"
+    icon={<FontAwesomeIcon icon={faGithub} />}
+    arrow={true}
+    href="https://github.com/tgreyuk/typedoc-plugin-markdown-examples/tree/main/examples/02-typedoc-plugin-frontmatter"
+    target="_blank"
+  />
+</Cards>
diff --git a/docs/pages/utilities/remark/_meta.json b/docs/pages/utilities/remark/_meta.json
@@ -1,5 +1,6 @@
 {
   "quick-start": "",
   "options": "",
-  "suggested-plugins": ""
+  "suggested-plugins": "",
+  "examples": ""
 }
diff --git a/docs/pages/utilities/remark/examples.mdx b/docs/pages/utilities/remark/examples.mdx
@@ -0,0 +1,16 @@
+import { Cards, Card } from 'nextra/components';
+import { faGithub } from '@fortawesome/free-brands-svg-icons';
+import { faBolt } from '@fortawesome/free-solid-svg-icons';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+
+# Examples
+
+<Cards num={2}>
+  <Card
+    title="View on Github"
+    icon={<FontAwesomeIcon icon={faGithub} />}
+    arrow={true}
+    href="https://github.com/tgreyuk/typedoc-plugin-markdown-examples/tree/main/examples/03-typedoc-plugin-remark"
+    target="_blank"
+  />
+</Cards>
diff --git a/docs/theme.config.jsx b/docs/theme.config.jsx
@@ -38,6 +38,7 @@ export default {
       titleTemplate: `${title || 'Introduction'} • typedoc-plugin-markdown`,
     };
   },
+  feedback: { content: null },
   navigation: {
     prev: true,
     next: true,