chore(global): updated docs for release

.changeset/changelog.js

@@ -1,7 +1,7 @@
 const getReleaseLine = async (changeset, _type) => {
   return changeset.summary.replace(
     /\(\#(.+?)\)/g,
-    '([#$1](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/$1))',
+    '([#$1](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/$1))',
   );
 };
 

.changeset/config.json

@@ -2,7 +2,7 @@
   "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
   "changelog": [
     "./changelog.js",
-    { "repo": "tgreyuk/typedoc-plugin-markdown" }
+    { "repo": "typedoc2md/typedoc-plugin-markdown" }
   ],
   "commit": false,
   "fixed": [],

.github/workflows/ci.docusaurus-plugin-typedoc.yml

@@ -28,7 +28,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: npm install
+        run: HUSKY=0 npm install
       - name: Lint
         run: npm run lint --workspace docusaurus-plugin-typedoc
       - name: Build

.github/workflows/ci.typedoc-github-wiki-theme.yml

@@ -28,7 +28,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: npm install
+        run: HUSKY=0 npm install
       - name: Lint
         run: npm run lint --workspace typedoc-github-wiki-theme
       - name: Build

.github/workflows/ci.typedoc-gitlab-wiki-theme.yml

@@ -28,7 +28,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: npm install
+        run: HUSKY=0 npm install
       - name: Lint
         run: npm run lint --workspace typedoc-github-wiki-theme
       - name: Build

.github/workflows/ci.typedoc-plugin-frontmatter.yml

@@ -28,7 +28,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: npm install
+        run: HUSKY=0 npm install
       - name: Lint
         run: npm run lint --workspace typedoc-plugin-frontmatter
       - name: Build

.github/workflows/ci.typedoc-plugin-remark.yml

@@ -28,7 +28,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: npm install
+        run: HUSKY=0 npm install
       - name: Lint
         run: npm run lint --workspace typedoc-plugin-remark
       - name: Build

.github/workflows/ci.typedoc-vitepress-theme.yml

@@ -28,7 +28,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: npm install
+        run: HUSKY=0 npm install
       - name: Lint
         run: npm run lint --workspace typedoc-vitepress-theme
       - name: Build

.github/workflows/ci.yml

@@ -20,6 +20,10 @@ jobs:
         node: ['18']
     name: Node ${{ matrix.node }}
     steps:
+      - name: Set Swap Space
+        uses: pierotofy/set-swap-space@master
+        with:
+          swap-size-gb: 10
       - name: Checkout repository
         uses: actions/checkout@v3
       - name: Set up Node
@@ -28,7 +32,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: npm install
+        run: HUSKY=0 npm install
       - name: Lint
         run: npm run lint --workspace typedoc-plugin-markdown
       - name: Build

README.md

@@ -6,21 +6,21 @@ This project is a collection of packages designed for generate TypeScript API do
 
 | Package | Badges | 
 | :---| :---|
-[typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-markdown) | 
-[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter) | 
-[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-remark%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark) | 
-[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-github-wiki-theme) | 
-[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme) | 
-[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-vitepress-theme) | 
-[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | ![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc) | 
+[typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-markdown) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-markdown?label=↓) | 
+[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-frontmatter) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter?label=↓) | 
+[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-remark.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-remark) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark?label=↓) | 
+[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-github-wiki-theme?label=↓) | 
+[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme?label=↓) | 
+[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-vitepress-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-vitepress-theme?label=↓) | 
+[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg?logo=npm)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc?label=↓) | 
 
 ## Documentation
 
 Please see [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org).
 
 ## Examples
 
-Please see the [examples repository](https://github.com/tgreyuk/typedoc-plugin-markdown-examples).
+Please see the [examples repository](https://github.com/typedoc2md/typedoc-plugin-markdown-examples).
 
 ## Contributing
 

devtools/examples/README.md

@@ -2,5 +2,5 @@ These folder is intended for internal dev purposes.
 
 For plugin examples please visit:
 
-- https://github.com/tgreyuk/typedoc-plugin-markdown-examples
+- https://github.com/typedoc2md/typedoc-plugin-markdown-examples
 - https://github.com/tgreyuk/typedoc-vitepress-theme-example

devtools/packages/fixtures/cli.ts

@@ -41,7 +41,7 @@ async function main() {
     const outputFileStrategies: ('members' | 'modules')[] =
       config.outputFileStrategies || ['members', 'modules'];
 
-    writeHtml(key, config.entryPoints);
+    //writeHtml(key, config.entryPoints);
     outputFileStrategies.forEach((outputFileStrategy) => {
       config.options.forEach((optionGroup, index: number) => {
         const options = {

devtools/packages/prebuild-options/tasks/generate-docs.ts

@@ -21,9 +21,11 @@ export async function generateOptionsDocs(docsConfig: DocsConfig) {
       `<Callout type="info">These options should be used in conjunction with the core [TypeDoc options](/docs/using-typedoc).</Callout>`,
     );
   } else {
-    out.push(
-      `<Callout type="info">Please view options exposed by [typedoc-plugin-markdown](/docs/options) in addition to those listed here.</Callout>`,
-    );
+    if (docsConfig.presets) {
+      out.push(
+        `<Callout type="info">Please view options exposed by [typedoc-plugin-markdown](/docs/options) in addition to those listed here.</Callout>`,
+      );
+    }
   }
 
   if (docsConfig.presets) {

devtools/scripts/generate-readmes.ts

@@ -1,17 +1,13 @@
 import { DOCS_CONFIG } from '@devtools/helpers';
 import { consola } from 'consola';
 import * as fs from 'fs';
-import * as path from 'path';
 
 main();
-copyChangelog();
+//copyChangelog();
 
-async function copyChangelog() {
+/*async function copyChangelog() {
   const changelog = fs.readFileSync(
-    path.join(
-      __dirname,
-      '../../packages/typedoc-plugin-markdown/CHANGELOG_V4.md',
-    ),
+    path.join(__dirname, '../../packages/typedoc-plugin-markdown/CHANGELOG.md'),
   );
   const readmeContents = changelog
     .toString()
@@ -22,7 +18,7 @@ async function copyChangelog() {
     path.join(__dirname, '../../docs/pages/docs/changelog.mdx'),
     `import { Callout } from 'nextra/components';\n\n` + readmeContents,
   );
-}
+}*/
 
 async function main() {
   const packagesPromises = [
@@ -65,8 +61,8 @@ function writeRepositoryReadme(packages: any) {
   const table: string[] = [];
   const rows = packages.map((packageItem) => {
     const badges = [
-      `![npm](https://img.shields.io/npm/v/${packageItem.name}%2Fnext?\&logo=npm)`,
-      `![Downloads](https://img.shields.io/npm/dm/${packageItem.name})`,
+      `[![npm](https://img.shields.io/npm/v/${packageItem.name}.svg?logo=npm)](https://www.npmjs.com/package/${packageItem.name})`,
+      `![Downloads](https://img.shields.io/npm/dm/${packageItem.name}?label=↓)`,
     ];
     return (
       [
@@ -88,7 +84,7 @@ function writeRepositoryReadme(packages: any) {
   readme.push('## Examples');
 
   readme.push(
-    'Please see the [examples repository](https://github.com/tgreyuk/typedoc-plugin-markdown-examples).',
+    'Please see the [examples repository](https://github.com/typedoc2md/typedoc-plugin-markdown-examples).',
   );
 
   readme.push('## Contributing');
@@ -111,25 +107,28 @@ function writePackageReadme(packageItem: any) {
       : `ci.${packageItem.name}.yml`;
   const readme = [`# ${packageItem.name}`];
   const badges = [
-    `![npm](https://img.shields.io/npm/v/${packageItem.name}%2Fnext?\&logo=npm)`,
-    `[![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/${ciName}/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/${ciName})`,
+    `[![npm](https://img.shields.io/npm/v/${packageItem.name}.svg?logo=npm)](https://www.npmjs.com/package/${packageItem.name})`,
+    `[![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/${ciName}/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/${ciName})`,
   ];
 
   readme.push(badges.join(' '));
-  readme.push(`${packageItem.description}`);
+  readme.push(`> ${packageItem.description}`);
   const docLink = `https://typedoc-plugin-markdown.org${
     DOCS_CONFIG[packageItem.name].docsPath
   }`;
 
   readme.push('## Installation');
   readme.push(`\`\`\`shell
-  npm install ${packageItem.name}@next --save-dev
+  npm install ${packageItem.name} --save-dev
   \`\`\``);
 
   readme.push('## Documentation');
   const resources = [docText(docLink)];
   readme.push(resources.join('\n'));
 
+  readme.push('## License');
+  readme.push('MIT');
+
   fs.writeFileSync(
     `./packages/${packageItem.name}/README.md`,
     readme.join('\n\n'),

docs/pages/api-docs/Class.MarkdownPageEvent.md

@@ -6,8 +6,8 @@ An event emitted by before and after the markup of a page is rendered.
 
 ```ts
 export function load(app: MarkdownApplication) {
-  app.renderer.on(MarkdownPageEvent.END, (event: MarkdownPageEvent) => {
-   events.contents = event.contents.replace('foo', 'bar');
+  app.renderer.on(MarkdownPageEvent.BEGIN, (page: MarkdownPageEvent) => {
+   page.contents = page.contents.replace('foo', 'bar');
   });
 });
 ```

docs/pages/docs/_meta.js

@@ -17,5 +17,5 @@ export default {
     type: 'separator',
     title: 'Support',
   },
-  changelog: '',
+  'migration-guide': 'Migration Guide v4.0',
 };

docs/pages/docs/index.mdx

@@ -15,11 +15,11 @@ Since many tools and platforms support Markdown, the documentation generated by
 
 ## Features
 
-- [MDX](https://mdxjs.com/) and [GFM](https://github.github.com/gfm/) compliant.
+- [CommonMark](https://spec.commonmark.org/0.31.2/), [GFM](https://github.github.com/gfm/) and [MDX](https://mdxjs.com/) compliant.
 - Works alongside other TypeDoc plugins.
 - Configurable output file structure.
 - Configurable UX options
-- [Frontmatter](/plugins/frontmatter) and [Remark](/plugins/remark) utility plugins available.
+- [Frontmatter](/plugins/frontmatter) and [remark](/plugins/remark) utility plugins available.
 
 ## Examples