Version Packages (next)

.changeset/polite-planets-knock.md

@@ -0,0 +1,10 @@
+---
+'typedoc-plugin-markdown': major
+---
+
+Initial release of next version. In summary includes:
+
+- Removal of handlebars as a dependency.
+- MDX2 support as standard (#305, #252).
+- Exposes additional output file options (#353, #338, #328, #307).
+- Several UI improvements.

.changeset/pre.json

@@ -2,7 +2,11 @@
   "mode": "pre",
   "tag": "next",
   "initialVersions": {
-    "typedoc-plugin-markdown": "3.13.4"
+    "typedoc-plugin-markdown": "3.13.4",
+    "docusaurus-plugin-typedoc": "0.17.6"
   },
-  "changesets": []
+  "changesets": [
+    "polite-planets-knock",
+    "twenty-moose-promise"
+  ]
 }

.changeset/twenty-moose-promise.md

@@ -0,0 +1,5 @@
+---
+'docusaurus-plugin-typedoc': major
+---
+
+- Compatibility updates for typedoc-plugin-markdown

.github/workflows/release.yml

@@ -1,5 +1,8 @@
 name: Release
-on: [pull_request]
+on:
+  push:
+    branches:
+      - next-release
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 jobs:
   release:
@@ -8,13 +11,17 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v3
-      - name: Setup Node.js 16
+      - name: Setup Node.js 16.x
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 16.x
       - name: Install Dependencies
-        run: yarn
-      - name: Create Release Pull Request
+        run: npm install
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
         uses: changesets/action@v1
+        with:
+          publish: npm run release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package.json

@@ -2,12 +2,14 @@
   "private": true,
   "workspaces": [
     "packages/typedoc-plugin-markdown",
-    "packages/typedoc-plugin-markdown"
+    "packages/docusaurus-plugin-typedoc"
   ],
   "scripts": {
     "lint": "npm run lint --workspaces",
     "build": "npm run build --workspaces",
-    "test": "npm run test --workspaces"
+    "test": "npm run test --workspaces",
+    "prerelease": "npm run build",
+    "release": "npx changeset publish"
   },
   "devDependencies": {
     "@changesets/cli": "^2.26.0",

packages/docusaurus-plugin-typedoc/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.0.0-next.0
+
+### Major Changes
+
+- Compatibility updates for typedoc-plugin-markdown
+
+### Patch Changes
+
+- Updated peer dependencies
+  - [email protected]
+
 ## [0.17.6](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/[email protected]@0.17.6) (2022-06-27)
 
 **Note:** Version bump only for package docusaurus-plugin-typedoc

packages/docusaurus-plugin-typedoc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "0.17.6",
+  "version": "1.0.0-next.0",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -17,10 +17,7 @@
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "peerDependencies": {
     "typedoc": ">=0.23.0",
-    "typedoc-plugin-markdown": ">=3.13.0"
-  },
-  "devDependencies": {
-    "typedoc-plugin-markdown": "^3.13.0"
+    "typedoc-plugin-markdown": ">=4.0.0-next.0"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",

packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/plugin.spec.ts.snap

@@ -1,19 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Plugin: (docs) should render 1`] = `
-[
-  "_category_.yml",
-  "classes",
-  "enums",
-  "functions",
-  "index.md",
-  "interfaces",
-  "Modules.md",
-  "namespaces",
-  "variables",
-]
-`;
-
 exports[`Plugin: (docs) should write category yaml 1`] = `
 "label: "Classes"
 position: 3"

packages/docusaurus-plugin-typedoc/test/specs/plugin.spec.ts

@@ -33,21 +33,17 @@ describe(`Plugin:`, () => {
       tmpobj = tmp.dirSync();
       await bootstrap(tmpobj);
     });
-    test(`should render`, () => {
-      const files = fs.readdirSync(tmpobj.name + '/docs/api');
-      expect(files.sort((a, b) => a.localeCompare(b))).toMatchSnapshot();
-    });
 
     test(`should write doc`, () => {
-      const sidebar = fs.readFileSync(tmpobj.name + '/docs/api/index.md');
-      expect(sidebar.toString()).toMatchSnapshot();
+      const indexDoc = fs.readFileSync(tmpobj.name + '/docs/api/index.md');
+      expect(indexDoc.toString()).toMatchSnapshot();
     });
 
     test(`should write category yaml`, () => {
-      const sidebar = fs.readFileSync(
+      const categoryYaml = fs.readFileSync(
         tmpobj.name + '/docs/api/classes/_category_.yml',
       );
-      expect(sidebar.toString()).toMatchSnapshot();
+      expect(categoryYaml.toString()).toMatchSnapshot();
     });
   });
 });

packages/typedoc-plugin-markdown/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 4.0.0-next.0
+
+### Major Changes
+
+Initial release of next version. In summary includes:
+
+- Removal of handlebars as a dependency.
+- MDX2 support as standard (#305, #252).
+- Exposes additional output file options (#353, #338, #328, #307).
+- Several UI improvements.
+
 ## [3.13.4](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/[email protected]@3.13.4) (2022-07-20)
 
 ### Fixes

packages/typedoc-plugin-markdown/README.md

@@ -32,9 +32,9 @@ The `--plugin` arg is optional (all plugins are loaded by default), however if u
 The following options can be used in addition to relevant [TypeDoc options](https://typedoc.org/guides/options/)
 (please note that TypeDoc options specific to the HTML theme will be ignored).
 
-Please read the [documentation](#documentation) for further configuration options.
+### File output options
 
-**File output options**
+See [File output options](./documentation/file-output-options.md) for further documentation.
 
 - **`--entryDocument`**<br>
   The file name of the entry document. Defaults to `README.md`.
@@ -43,7 +43,7 @@ Please read the [documentation](#documentation) for further configuration option
 - **`--fileStructure`**<br>
   Specifies how the files should be generated, grouped by modules or symbol types. Expected values [`modules`, `symbols`]. Defaults to `modules`.
 
-**UI options**
+### UI options
 
 - **`--hideBreadcrumbs`**<br>
   Do not print breadcrumbs header. Defaults to `false`.
@@ -53,10 +53,8 @@ Please read the [documentation](#documentation) for further configuration option
   Do not print the page title. Defaults to `false`.
 - **`--hideHierarchy`**<br>
   Do not print reflection hierarchy. Defaults to `false`.
-- **`--typeDeclarationStyle`**<br>
-  Specify the render style of type declarations. Expected values [`list`, `table`] Defaults to `list`.
 
-**Utility options**
+### Utility options
 
 - **`--namedAnchors`**<br>
   Use HTML named anchors tags for implementations that do not assign header ids. Defaults to `false`.
@@ -65,7 +63,7 @@ Please read the [documentation](#documentation) for further configuration option
 
 ## Documentation
 
-- [Output file strategy](./documentation/output-file-strategy.md)
+- [File output options](./documentation/file-output-options.md)
 
 ## License
 

packages/typedoc-plugin-markdown/documentation/output-file-strategy.md → packages/typedoc-plugin-markdown/documentation/file-output-options.md

@@ -1,4 +1,4 @@
-# Output file strategy
+# File output options
 
 TypeDoc creates documentation according to exports. The modules strucutre will be driven by the implemented an entry point config. https://typedoc.org/guides/options/#entrypointstrategy.
 
@@ -41,7 +41,7 @@ _Note when definiting arrays using a json options file is less verbose:_
 
 ## Configuring the output directory structure
 
-### Default structure
+### Default structure (by symbols)
 
 As per the HTML theme, by default the plugin groups exports in directories following the symbol type producing the following output.
 

packages/typedoc-plugin-markdown/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typedoc-plugin-markdown",
-  "version": "3.13.4",
+  "version": "4.0.0-next.0",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
   "main": "dist/index.js",
   "files": [

packages/typedoc-plugin-markdown/src/index.ts

@@ -30,7 +30,7 @@ export function load(app: Application) {
     name: 'fileStructure',
     help: '[Markdown Plugin] Specifies how the filesystem should be standard. Hierarchical builds directories as per file system.',
     type: ParameterType.String,
-    defaultValue: 'modules',
+    defaultValue: 'symbols',
     validate: (option) => {
       const availableValues = ['modules', 'symbols'];
       if (!availableValues.includes(option)) {

packages/typedoc-plugin-markdown/src/support/utils.ts

@@ -12,8 +12,8 @@ export function formatContents(contents: string) {
 
 export function escapeChars(str: string) {
   return str
-    .replace(/</g, '\\<')
-    .replace(/>/g, '\\>')
+    .replace(/>/g, '\\<')
+    .replace(/{/g, '\\{')
     .replace(/_/g, '\\_')
     .replace(/`/g, '\\`')
     .replace(/\|/g, '\\|');