From 2eeb265bd8a13510529655ff28d2ae499929ceb4 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Sun, 23 Jun 2024 00:14:46 +0100 Subject: [PATCH] chore(docs): updated example links --- docs/pages/docs/index.mdx | 2 +- docs/pages/plugins/docusaurus.mdx | 14 +++++++------- docs/pages/plugins/frontmatter.mdx | 2 +- docs/pages/plugins/github-wiki.mdx | 2 +- docs/pages/plugins/remark.mdx | 2 +- docs/pages/plugins/vitepress.mdx | 14 +++++++------- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/pages/docs/index.mdx b/docs/pages/docs/index.mdx index 4a57d9c9f..89c5199f2 100644 --- 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={} arrow={true} - href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples" + href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/blob/main/README.md" target="_blank" /> diff --git a/docs/pages/plugins/docusaurus.mdx b/docs/pages/plugins/docusaurus.mdx index 9936a66bb..008d2fcc9 100644 --- a/docs/pages/plugins/docusaurus.mdx +++ b/docs/pages/plugins/docusaurus.mdx @@ -2,7 +2,7 @@ import { Cards } from 'nextra/components'; import pjson from '../../../packages/docusaurus-plugin-typedoc/package.json'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; import { faGithub } from '@fortawesome/free-brands-svg-icons'; -import { faBolt } from '@fortawesome/free-solid-svg-icons'; +import { faGlobe } from '@fortawesome/free-solid-svg-icons'; # docusaurus-plugin-typedoc @@ -37,17 +37,17 @@ The following is a simple example of a Docusaurus project running TypeDoc. } + title="View Demo Site" + icon={} arrow={true} - href="https://github.com/typedoc-plugin-markdown/docusaurus-plugin-typedoc-example" + href="https://docusaurus-plugin-typedoc-example-docs-website.vercel.app" target="_blank" /> } + title="View Code on GitHub" + icon={} arrow={true} - href="https://stackblitz.com/~/github.com/typedoc-plugin-markdown/docusaurus-plugin-typedoc-example" + href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/integrations/docusaurus" target="_blank" /> diff --git a/docs/pages/plugins/frontmatter.mdx b/docs/pages/plugins/frontmatter.mdx index 96414d9f9..06e281a87 100644 --- a/docs/pages/plugins/frontmatter.mdx +++ b/docs/pages/plugins/frontmatter.mdx @@ -25,7 +25,7 @@ This plugin is designed to prepend a YAML frontmatter block to the content of ea title="View on GitHub" icon={} arrow={true} - href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/08-frontmatter-example#readme" + href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/utils/frontmatter" target="_blank" /> diff --git a/docs/pages/plugins/github-wiki.mdx b/docs/pages/plugins/github-wiki.mdx index e96c895a1..cecc97a4f 100644 --- a/docs/pages/plugins/github-wiki.mdx +++ b/docs/pages/plugins/github-wiki.mdx @@ -33,7 +33,7 @@ The following is a simple example of a GithubWiki project running TypeDoc. title="View Source on Github" icon={} arrow={true} - href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/07-typedoc-github-wiki-theme" + href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/integrations/github-wiki" target="_blank" /> diff --git a/docs/pages/plugins/remark.mdx b/docs/pages/plugins/remark.mdx index 8a028f441..3df38851f 100644 --- a/docs/pages/plugins/remark.mdx +++ b/docs/pages/plugins/remark.mdx @@ -24,7 +24,7 @@ This plugin enables additional Markdown transformations with remark plugins. title="View on GitHub" icon={} arrow={true} - href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/blob/main/examples/09-remark-example/docs/README.md" + href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/utils/remark" target="_blank" /> diff --git a/docs/pages/plugins/vitepress.mdx b/docs/pages/plugins/vitepress.mdx index 8cfba0c44..b51ec6a86 100644 --- a/docs/pages/plugins/vitepress.mdx +++ b/docs/pages/plugins/vitepress.mdx @@ -4,7 +4,7 @@ import { Callout, Steps } from 'nextra/components'; import { Cards } from 'nextra/components'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; import { faGithub } from '@fortawesome/free-brands-svg-icons'; -import { faBolt } from '@fortawesome/free-solid-svg-icons'; +import { faGlobe } from '@fortawesome/free-solid-svg-icons'; # typedoc-vitepress-theme @@ -31,17 +31,17 @@ The following is a simple example of a VitePress project running TypeDoc. } + title="View Demo Site" + icon={} arrow={true} - href="https://github.com/typedoc-plugin-markdown/typedoc-vitepress-theme-example" + href="https://typedoc-vitepress-theme-example-docs-rf58bio35.vercel.app/" target="_blank" /> } + title="View Code on GitHub" + icon={} arrow={true} - href="https://stackblitz.com/~/github.com/typedoc-plugin-markdown/typedoc-vitepress-theme-example" + href="https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/integrations/vitepress" target="_blank" />