chore: Switched to changesets and npm workspaces

2026-01-31 00:45:20 +01:00 · 2022-12-07 23:07:18 +00:00
parent c943e6a5c2
commit e86bda396e
20 changed files with 12013 additions and 17593 deletions
--- a/.changeset/README.md
+++ b/.changeset/README.md
@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
--- a/.changeset/config.json
+++ b/.changeset/config.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.2.0/schema.json",
+  "changelog": "../scripts/changesets/changelog.js",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "next",
+  "updateInternalDependencies": "minor",
+  "ignore": []
+}
--- a/.changeset/pre.json
+++ b/.changeset/pre.json
@@ -0,0 +1,8 @@
+{
+  "mode": "pre",
+  "tag": "next",
+  "initialVersions": {
+    "typedoc-plugin-markdown": "3.13.4"
+  },
+  "changesets": []
+}
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,7 +1,7 @@
 name: CI
-on: [push, pull_request]
+on: [pull_request]
 jobs:
-  build:
+  lint-and-test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
@@ -14,15 +14,11 @@ jobs:
        uses: actions/setup-node@v3
        with:
          node-version: ${{ matrix.node }}
-      - name: Upgrade yarn
-        run: yarn install
      - name: Install
-        run: yarn
+        run: npm install
      - name: Lint
-        run: yarn run lint
+        run: npm run lint
      - name: Build
-        run: yarn run build
-      - name: Markdownlint
-        run: yarn run markdownlint
+        run: npm run build
      - name: Test
-        run: yarn test
+        run: npm run test
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -0,0 +1,20 @@
+name: Release
+on: [pull_request]
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Install Dependencies
+        run: yarn
+      - name: Create Release Pull Request
+        uses: changesets/action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
--- a/lerna.json
+++ b/lerna.json
@@ -1,14 +0,0 @@
-{
-  "npmClient": "yarn",
-  "useWorkspaces": true,
-  "useNx": true,
-  "version": "independent",
-  "ignoreChanges": ["**/*.json", "**/*.md", "**/*.spec.ts", "**/*.snap"],
-  "command": {
-    "version": {
-      "allowBranch": "master",
-      "conventionalCommits": true,
-      "message": "chore(release)"
-    }
-  }
-}
--- a/nx.json
+++ b/nx.json
@@ -1,11 +0,0 @@
-{
-  "extends": "nx/presets/npm.json",
-  "tasksRunnerOptions": {
-    "default": {
-      "runner": "nx/tasks-runners/default",
-      "options": {
-        "cacheableOperations": ["build"]
-      }
-    }
-  }
-}
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,17 +1,15 @@
 {
  "private": true,
  "workspaces": [
-    "packages/*",
-    "examples/*"
+    "packages/typedoc-plugin-markdown"
  ],
  "scripts": {
-    "lint": "lerna run lint",
-    "build": "lerna run build",
-    "markdownlint": "lerna run markdownlint",
-    "test": "lerna run test --parallel",
-    "deploy": "lerna publish from-package"
+    "lint": "npm run lint --workspaces",
+    "build": "npm run build --workspaces",
+    "test": "npm run test --workspaces"
  },
  "devDependencies": {
+    "@changesets/cli": "^2.25.2",
    "@types/fs-extra": "^9.0.13",
    "@types/jest": "^29.2.4",
    "@types/node": "^18.11.11",
@@ -20,11 +18,9 @@
    "eslint": "^8.29.0",
    "fs-extra": "^11.1.0",
    "jest": "^29.3.1",
-    "lerna": "^6.1.0",
    "markdownlint": "^0.26.2",
    "markdownlint-cli": "^0.32.2",
    "npm-run-all": "^4.1.5",
-    "nx": "^15.2.4",
    "prettier": "^2.8.0",
    "ts-jest": "^29.0.3",
    "ts-morph": "^17.0.1",
--- a/packages/docusaurus-plugin-typedoc/CHANGELOG.md
+++ b/packages/docusaurus-plugin-typedoc/CHANGELOG.md
@@ -1,29 +1,15 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+# Changelog

 ## [0.17.6](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.5...docusaurus-plugin-typedoc@0.17.6) (2022-06-27)

 **Note:** Version bump only for package docusaurus-plugin-typedoc

-
-
-
-
-
 ## [0.17.5](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.4...docusaurus-plugin-typedoc@0.17.5) (2022-05-10)

-
 ### Bug Fixes

-* added sidebar.autoConfiguration option ([f873b32](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f873b32f2342b74c68f0bda8e7661b265b4d93ab))
-* Removed index slug ([3667eb5](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/3667eb59035b422b4f569f76635cfe682fbac5ac))
-
-
-
-
-
+- added sidebar.autoConfiguration option ([f873b32](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f873b32f2342b74c68f0bda8e7661b265b4d93ab))
+- Removed index slug ([3667eb5](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/3667eb59035b422b4f569f76635cfe682fbac5ac))

 ## [0.17.4](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.3...docusaurus-plugin-typedoc@0.17.4) (2022-04-21)

--- a/packages/typedoc-bitbucket-theme/CHANGELOG.md
+++ b/packages/typedoc-bitbucket-theme/CHANGELOG.md
@@ -1,7 +1,4 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+# Changelog

 # 1.0.0 (2022-01-09)

@@ -9,17 +6,11 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

 Internally initiate with TypeDoc `defineTheme` method (`theme` option should be keyword rather than path)

-
 # 0.1.0 (2021-09-21)

-
 ### Features

-* TypeDoc 0.22 compatibility fixes ([895d586](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/895d586e36da11e7fee9931d52c51a78e868e08f))
-
-
-
-
+- TypeDoc 0.22 compatibility fixes ([895d586](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/895d586e36da11e7fee9931d52c51a78e868e08f))

 ## [0.0.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-bitbucket-theme@0.0.1...typedoc-bitbucket-theme@0.0.1) (2021-02-21)

--- a/packages/typedoc-github-wiki-theme/CHANGELOG.md
+++ b/packages/typedoc-github-wiki-theme/CHANGELOG.md
@@ -1,19 +1,10 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+# Changelog

 ## [1.0.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.6.1...typedoc-github-wiki-theme@1.0.1) (2022-05-15)

-
 ### Bug Fixes

-* Fixed incorrect toc anchors ([753a534](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/753a5340f8c29d692221152e0f49251f987707c8))
-
-
-
-
-
+- Fixed incorrect toc anchors ([753a534](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/753a5340f8c29d692221152e0f49251f987707c8))

 # 1.0.0 (2022-01-09)

@@ -21,99 +12,57 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

 Internally initiate with TypeDoc `defineTheme` method (`theme` option should be keyword rather than path)

-
 ## [0.6.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.6.0...typedoc-github-wiki-theme@0.6.1) (2022-01-09)

-
 ### Bug Fixes

-* Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45))
-
-
-
-
+- Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45))

 # [0.6.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.5.1...typedoc-github-wiki-theme@0.6.0) (2021-09-21)

-
 ### Features

-* TypeDoc 0.22 compatibility fixes ([f68442d](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f68442d13e448d86d444e71f5781921cb4ac795e))
-
-
-
-
+- TypeDoc 0.22 compatibility fixes ([f68442d](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f68442d13e448d86d444e71f5781921cb4ac795e))

 ## [0.5.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.5.0...typedoc-github-wiki-theme@0.5.1) (2021-07-14)

-
 ### Bug Fixes

-* Replace forward slash with periods for filenames ([#242](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/242)) ([69e31f2](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/69e31f2ff8e9f516897bbddefb208905ed4ecaa5))
-
-
-
-
+- Replace forward slash with periods for filenames ([#242](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/242)) ([69e31f2](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/69e31f2ff8e9f516897bbddefb208905ed4ecaa5))

 # [0.5.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.4.3...typedoc-github-wiki-theme@0.5.0) (2021-07-13)

-
 ### Features

-* Generate unique page names ([#242](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/242)) ([7802fd3](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/7802fd30775be167e520aaba41a04f649a569877))
-
-
-
-
+- Generate unique page names ([#242](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/242)) ([7802fd3](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/7802fd30775be167e520aaba41a04f649a569877))

 ## [0.4.3](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.4.2...typedoc-github-wiki-theme@0.4.3) (2021-07-12)

-
 ### Bug Fixes

-* Handle TypeDoc 0.21.3 options breaking change ([38df28f](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/38df28f4ef6821c097d4ac3145984d57fad2e8a8))
-
-
-
-
+- Handle TypeDoc 0.21.3 options breaking change ([38df28f](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/38df28f4ef6821c097d4ac3145984d57fad2e8a8))

 ## [0.4.2](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.4.1...typedoc-github-wiki-theme@0.4.2) (2021-06-19)

-
 ### Bug Fixes

-* Fix output directory check ([121ffe4](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/121ffe48717db57216314b4dc7a6646bd4a1b454))
-* Remove colon from filenames to fix windows compatibility ([#237](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/237)) ([554cd44](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/554cd44b2bc48b737cfb15df8e828ceea5101d19))
-
-
-
-
+- Fix output directory check ([121ffe4](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/121ffe48717db57216314b4dc7a6646bd4a1b454))
+- Remove colon from filenames to fix windows compatibility ([#237](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/237)) ([554cd44](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/554cd44b2bc48b737cfb15df8e828ceea5101d19))

 ## [0.4.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.4.0...typedoc-github-wiki-theme@0.4.1) (2021-06-19)

-
 ### Bug Fixes

-* Remove reference to fs-extra ([#236](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/236)) ([dfec277](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/dfec277f583a398ce6f40a0ea0f2361bebab1f88))
-
-
-
-
+- Remove reference to fs-extra ([#236](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/236)) ([dfec277](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/dfec277f583a398ce6f40a0ea0f2361bebab1f88))

 # [0.4.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.3.0...typedoc-github-wiki-theme@0.4.0) (2021-06-18)

-
 ### Features

-* TypeDoc 0.21 compatibility ([d19d6f3](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/d19d6f37a4648e48f334cf24b82b6cc9fea00abc))
-
-
-
-
+- TypeDoc 0.21 compatibility ([d19d6f3](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/d19d6f37a4648e48f334cf24b82b6cc9fea00abc))

 # [0.3.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.2.1...typedoc-github-wiki-theme@0.3.0) (2021-05-11)

-
 ### Features

-* Improved sidebar structure ([58798fd](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/58798fd4b25299c8d69d6671b477973c3b896aaa))
+- Improved sidebar structure ([58798fd](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/58798fd4b25299c8d69d6671b477973c3b896aaa))
--- a/packages/typedoc-github-wiki-theme/src/theme.ts
+++ b/packages/typedoc-github-wiki-theme/src/theme.ts
@@ -6,8 +6,8 @@ export class GithubWikiTheme extends MarkdownTheme {
  constructor(renderer: Renderer) {
    super(renderer);

-    this.entryDocument = 'Home.md';
-    this.hideBreadcrumbs = true;
+    //this.entryDocument = 'Home.md';
+    //this.hideBreadcrumbs = true;

    this.listenTo(this.owner, {
      [RendererEvent.END]: this.writeSidebar,
@@ -24,10 +24,10 @@ export class GithubWikiTheme extends MarkdownTheme {

  writeSidebar(renderer: any) {
    const parseUrl = (url: string) => '../wiki/' + url.replace('.md', '');
-    const navigation = this.getNavigation(renderer.project);
+    //const navigation = this.getNavigation(renderer.project);
    const navJson: string[] = [`## ${renderer.project.name}\n`];
    const allowedSections = ['Home', 'Modules', 'Namespaces'];
-    navigation.children
+    /*navigation.children
      ?.filter(
        (navItem) =>
          !navItem.isLabel || allowedSections.includes(navItem.title),
@@ -47,7 +47,7 @@ export class GithubWikiTheme extends MarkdownTheme {
            navItem.url === this.entryDocument ? 'Home' : navItem.title;
          navJson.push(`- [${title}](${parseUrl(navItem.url)})`);
        }
-      });
+      });*/

    fs.writeFileSync(
      renderer.outputDirectory + '/_Sidebar.md',
--- a/packages/typedoc-gitlab-wiki-theme/CHANGELOG.md
+++ b/packages/typedoc-gitlab-wiki-theme/CHANGELOG.md
@@ -1,7 +1,4 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+# Changelog

 # 1.0.0 (2022-01-09)

@@ -9,67 +6,40 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

 Internally initiate with TypeDoc `defineTheme` method (`theme` option should be keyword rather than path)

-
 ## [0.2.2](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.2.1...typedoc-gitlab-wiki-theme@0.2.2) (2022-01-09)

-
 ### Bug Fixes

-* Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45))
-
-
-
-
+- Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45))

 ## [0.2.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.2.0...typedoc-gitlab-wiki-theme@0.2.1) (2021-11-26)

-
 ### Bug Fixes

-* **urls:** Fixes relative urls for typedoc-gitlab-wiki-theme [269] ([31e45ea](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/31e45ea5b996bf15a69b3a903fd51669d82a88e9))
-
-
-
-
+- **urls:** Fixes relative urls for typedoc-gitlab-wiki-theme [269] ([31e45ea](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/31e45ea5b996bf15a69b3a903fd51669d82a88e9))

 # [0.2.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.1.2...typedoc-gitlab-wiki-theme@0.2.0) (2021-09-21)

-
 ### Features

-* TypeDoc 0.22 compatibility fixes ([f20f79a](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f20f79ab3c018c69bf67a2e8969880e53a2c6270))
-* TypeDoc 0.22 compatibility fixes ([#249](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/249)) ([963250c](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/963250cbe0b12bc3f413b5138d6d4e33ad2a6353))
-
-
-
-
+- TypeDoc 0.22 compatibility fixes ([f20f79a](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f20f79ab3c018c69bf67a2e8969880e53a2c6270))
+- TypeDoc 0.22 compatibility fixes ([#249](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/249)) ([963250c](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/963250cbe0b12bc3f413b5138d6d4e33ad2a6353))

 ## [0.1.2](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.1.1...typedoc-gitlab-wiki-theme@0.1.2) (2021-07-12)

-
 ### Bug Fixes

-* Handle TypeDoc 0.21.3 options breaking change ([38df28f](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/38df28f4ef6821c097d4ac3145984d57fad2e8a8))
-
-
-
-
+- Handle TypeDoc 0.21.3 options breaking change ([38df28f](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/38df28f4ef6821c097d4ac3145984d57fad2e8a8))

 ## [0.1.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.1.0...typedoc-gitlab-wiki-theme@0.1.1) (2021-06-19)

-
 ### Bug Fixes

-* Fix output directory check ([328ef00](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/328ef00e50da988f62201c9a91548e909699c587))
-* Remove colon from filenames to fix windows compatibility ([115d133](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/115d133d296e6a7e8ceb7b46b6c88f2dbb7ee7d1))
-
-
-
-
+- Fix output directory check ([328ef00](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/328ef00e50da988f62201c9a91548e909699c587))
+- Remove colon from filenames to fix windows compatibility ([115d133](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/115d133d296e6a7e8ceb7b46b6c88f2dbb7ee7d1))

 # [0.1.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.0.1...typedoc-gitlab-wiki-theme@0.1.0) (2021-05-11)

-
 ### Features

-* Improved sidebar structure ([09e713a](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/09e713a4731fc3effceaf720bdefdba0c398d608))
+- Improved sidebar structure ([09e713a](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/09e713a4731fc3effceaf720bdefdba0c398d608))
--- a/packages/typedoc-gitlab-wiki-theme/src/theme.ts
+++ b/packages/typedoc-gitlab-wiki-theme/src/theme.ts
@@ -1,6 +1,4 @@
-import * as fs from 'fs';
-
-import { Renderer, DeclarationReflection, RendererEvent } from 'typedoc';
+import { Renderer } from 'typedoc';
 import { MarkdownTheme } from 'typedoc-plugin-markdown';

 export class GitlabWikiTheme extends MarkdownTheme {
@@ -8,50 +6,8 @@ export class GitlabWikiTheme extends MarkdownTheme {
    super(renderer);

    this.entryDocument = 'home.md';
-    this.hideBreadcrumbs = true;
-    this.hidePageTitle = true;
-
-    this.listenTo(this.owner, {
-      [RendererEvent.END]: this.onGitLabRendererEnd,
-    });
-  }
-
-  getRelativeUrl(url: string) {
-    const relativeUrl = super
-      .getRelativeUrl(url)
-      .replace(/(.*).md/, '$1')
-      .replace(/ /g, '-');
-    return relativeUrl.startsWith('..') ? relativeUrl : './' + relativeUrl;
-  }
-
-  toUrl(mapping: any, reflection: DeclarationReflection) {
-    return `${mapping.directory}/${reflection.getFullName()}.md`;
-  }
-
-  onGitLabRendererEnd(renderer: RendererEvent) {
-    const parseUrl = (url: string) => url.replace(/(.*).md/, '$1');
-    const navigation = this.getNavigation(renderer.project);
-    const navJson: string[] = [`## ${renderer.project.name}\n`];
-    navigation.children?.forEach((navItem) => {
-      if (navItem.isLabel) {
-        navJson.push(`\n### ${navItem.title}\n`);
-        navItem.children?.forEach((navItemChild) => {
-          const longTitle = navItemChild.title.split('.');
-          const shortTitle = longTitle[longTitle.length - 1];
-          navJson.push(
-            `- [${shortTitle}](${parseUrl(encodeURI(navItemChild.url))})`,
-          );
-        });
-      } else {
-        const title =
-          navItem.url === this.entryDocument ? 'Home' : navItem.title;
-        navJson.push(`- [${title}](${parseUrl(navItem.url)})`);
-      }
-    });
-    fs.writeFileSync(
-      renderer.outputDirectory + '/_sidebar.md',
-      navJson.join('\n'),
-    );
+    // this.hideBreadcrumbs = true;
+    // this.hidePageTitle = true;
  }

  get globalsFile() {
--- a/packages/typedoc-hugo-theme/CHANGELOG.md
+++ b/packages/typedoc-hugo-theme/CHANGELOG.md
@@ -1,8 +1,4 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
+# Changelog

 # 1.0.0 (2022-01-09)

@@ -10,81 +6,48 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

 Internally initiate with TypeDoc `defineTheme` method (`theme` option should be keyword rather than path)

-
 # [0.4.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-hugo-theme@0.3.0...typedoc-hugo-theme@0.4.0) (2022-01-09)

-
 ### Bug Fixes

-* Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45))
-
+- Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45))

 ### Features

-* TypeDoc 0.22 compatibility fixes ([5bda95d](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5bda95d95aa42ec66ec893eef51507794ad52b3d))
-
-
-
-
+- TypeDoc 0.22 compatibility fixes ([5bda95d](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5bda95d95aa42ec66ec893eef51507794ad52b3d))

 # [0.3.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-hugo-theme@0.3.0...typedoc-hugo-theme@0.3.0) (2021-09-21)

-
 ### Features

-* TypeDoc 0.22 compatibility fixes ([5bda95d](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5bda95d95aa42ec66ec893eef51507794ad52b3d))
-
-
-
-
+- TypeDoc 0.22 compatibility fixes ([5bda95d](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/5bda95d95aa42ec66ec893eef51507794ad52b3d))

 # [0.3.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-hugo-theme@0.2.1...typedoc-hugo-theme@0.3.0) (2021-09-14)

-
 ### Features

-* TypeDoc 0.22 compatibility fixes ([#249](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/249)) ([963250c](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/963250cbe0b12bc3f413b5138d6d4e33ad2a6353))
-
-
-
-
+- TypeDoc 0.22 compatibility fixes ([#249](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/249)) ([963250c](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/963250cbe0b12bc3f413b5138d6d4e33ad2a6353))

 ## [0.2.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-hugo-theme@0.2.0...typedoc-hugo-theme@0.2.1) (2021-07-12)

-
 ### Bug Fixes

-* Handle TypeDoc 0.21.3 options breaking change ([c07ef46](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/c07ef4660bd126a3b97356f862a8e1019d97c5a8))
-
-
-
-
+- Handle TypeDoc 0.21.3 options breaking change ([c07ef46](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/c07ef4660bd126a3b97356f862a8e1019d97c5a8))

 # [0.2.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-hugo-theme@0.1.1...typedoc-hugo-theme@0.2.0) (2021-03-04)

-
 ### Features

-* Added Branch Bundle `_index.md` files ([f3c7118](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f3c7118af9b53f63ea40ac5937ec57e08b9f6ec8))
-
-
-
-
+- Added Branch Bundle `_index.md` files ([f3c7118](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/f3c7118af9b53f63ea40ac5937ec57e08b9f6ec8))

 ## [0.1.1](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-hugo-theme@0.1.0...typedoc-hugo-theme@0.1.1) (2021-03-03)

-
 ### Bug Fixes

-* Remove slug root dir ([#197](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/197)) ([c7e2586](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/c7e25862c6ac0e34547b0e7636cb66acb51e5791))
-
-
-
-
+- Remove slug root dir ([#197](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/197)) ([c7e2586](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/c7e25862c6ac0e34547b0e7636cb66acb51e5791))

 ## 0.1.0 (2021-02-27)

-
 ### Features

-* Added Hugo theme / front matter support ([3cd1bf8](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/3cd1bf894533966f75ccd56c1b7cd2078e7084c0))
+- Added Hugo theme / front matter support ([3cd1bf8](https://github.com/tgreyuk/typedoc-plugin-markdown/commit/3cd1bf894533966f75ccd56c1b7cd2078e7084c0))
--- a/packages/typedoc-plugin-markdown/CHANGELOG.md
+++ b/packages/typedoc-plugin-markdown/CHANGELOG.md
@@ -1,7 +1,4 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+# Changelog

 ## [3.13.4](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.3...typedoc-plugin-markdown@3.13.4) (2022-07-20)

--- a/packages/vuepress-plugin-typedoc/CHANGELOG.md
+++ b/packages/vuepress-plugin-typedoc/CHANGELOG.md
@@ -1,7 +1,4 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+# Changelog

 # [0.11.0](https://github.com/tgreyuk/typedoc-plugin-markdown/compare/vuepress-plugin-typedoc@0.10.3...vuepress-plugin-typedoc@0.11.0) (2022-07-25)

--- a/scripts/changesets/changelog.js
+++ b/scripts/changesets/changelog.js
@@ -0,0 +1,32 @@
+const getReleaseLine = async (changeset, _type) => {
+  const [firstLine, ...futureLines] = changeset.summary
+    .split('\n')
+    .map((l) => l.trimRight());
+
+  let returnVal = `- ${firstLine}`;
+
+  if (futureLines.length > 0) {
+    returnVal += `\n- ${futureLines.map((l) => `  ${l}`).join('\n')}`;
+  }
+
+  return returnVal;
+};
+
+const getDependencyReleaseLine = async (changesets, dependenciesUpdated) => {
+  if (dependenciesUpdated.length === 0) return '';
+
+  const updatedDependenciesList = dependenciesUpdated.map(
+    (dependency) => `  - ${dependency.name}@${dependency.newVersion}`,
+  );
+
+  return [['- Updated peer dependencies'], ...updatedDependenciesList].join(
+    '\n',
+  );
+};
+
+const defaultChangelogFunctions = {
+  getReleaseLine,
+  getDependencyReleaseLine,
+};
+
+exports.default = defaultChangelogFunctions;
--- a/yarn.lock
+++ b/yarn.lock