chore(global): updated readmes

typedoc2md · May 3, 2024 · 44bfbf0 · 44bfbf0
1 parent 07ee25a
commit 44bfbf0
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 23 deletions.
diff --git a/devtools/scripts/generate-readmes.ts b/devtools/scripts/generate-readmes.ts
@@ -3,22 +3,6 @@ import { consola } from 'consola';
 import * as fs from 'fs';
 
 main();
-//copyChangelog();
-
-/*async function copyChangelog() {
-  const changelog = fs.readFileSync(
-    path.join(__dirname, '../../packages/typedoc-plugin-markdown/CHANGELOG.md'),
-  );
-  const readmeContents = changelog
-    .toString()
-    .replace(/^>(.*)$/gm, '<Callout>$1</Callout>')
-    .replace(/<!--[\s\S]*?-->/g, '');
-
-  fs.writeFileSync(
-    path.join(__dirname, '../../docs/pages/docs/changelog.mdx'),
-    `import { Callout } from 'nextra/components';\n\n` + readmeContents,
-  );
-}*/
 
 async function main() {
   const packagesPromises = [
@@ -114,9 +98,12 @@ function writePackageReadme(packageItem: any) {
 
   readme.push(badges.join(' '));
   readme.push(`> ${packageItem.description}`);
-  const docLink = `https://typedoc-plugin-markdown.org${
-    DOCS_CONFIG[packageItem.name].docsPath
-  }`;
+  const docLink =
+    packageItem.name === 'typedoc-plugin-markdown'
+      ? 'https://typedoc-plugin-markdown.org'
+      : `https://typedoc-plugin-markdown.org${
+          DOCS_CONFIG[packageItem.name].docsPath
+        }`;
 
   readme.push('## Installation');
   readme.push(`\`\`\`shell

diff --git a/packages/typedoc-github-wiki-theme/README.md b/packages/typedoc-github-wiki-theme/README.md
@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-github-wiki-theme.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-github-wiki-theme.yml)
 
-> A TypeDoc ( + typedoc-plugin-markdown ) theme that generates docs compatible with Github Wiki.
+> A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Github Wiki.
 
 ## Installation
 

diff --git a/packages/typedoc-gitlab-wiki-theme/README.md b/packages/typedoc-gitlab-wiki-theme/README.md
@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-gitlab-wiki-theme.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-gitlab-wiki-theme.yml)
 
-> A TypeDoc ( + typedoc-plugin-markdown ) theme that generates docs compatible with Gitlab Wiki.
+> A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Gitlab Wiki.
 
 ## Installation
 

diff --git a/packages/typedoc-plugin-markdown/README.md b/packages/typedoc-plugin-markdown/README.md
@@ -12,7 +12,7 @@
 
 ## Documentation
 
-Please visit the [https://typedoc-plugin-markdown.org/docs](https://typedoc-plugin-markdown.org/docs) for comprehensive documentation, including options and usage guides.
+Please visit the [https://typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org) for comprehensive documentation, including options and usage guides.
 
 ## License
 

diff --git a/packages/typedoc-vitepress-theme/README.md b/packages/typedoc-vitepress-theme/README.md
@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-vitepress-theme) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-vitepress-theme.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-vitepress-theme.yml)
 
-> A TypeDoc ( + typedoc-plugin-markdown ) theme that generates markdown compatible with VitePress.
+> A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress.
 
 ## Installation