chore(docs): docs update

.prettierrc.json

@@ -2,4 +2,4 @@
   "singleQuote": true,
   "trailingComma": "all",
   "plugins": ["prettier-plugin-organize-imports"]
-}
+}

CONTRIBUTING.md

@@ -1,38 +1,36 @@
 # Contributing Guide
 
-Thank you for showing interest in contributing to this project. This guide provides some basic guidelines for doing so.
+> How to contribute to "typedoc-plugin-markdown" and associated packages.
 
 ## Contents
 
-- [Contributing Guide](#contributing-guide)
-  - [Contents](#contents)
-  - [Introduction](#introduction)
-  - [Contributions to the public docs](#contributions-to-the-public-docs)
-  - [Contributing to the codebase](#contributing-to-the-codebase)
-  - [Submitting a Pull Request](#submitting-a-pull-request)
-  - [Contributors](#contributors)
+- [Introduction](#introduction)
+- [Contributing to the public docs](#contributing-to-the-public-docs)
+- [Contributing to the codebase](#contributing-to-the-codebase)
+- [Submitting a PR](#submitting-a-pr)
+- [Acknowledgements](#acknowledgements)
 
 ## Introduction
 
-Before you start, you might find it helpful to read the [TypeDoc development guide](https://typedoc.org/guides/development/) to understand the architecture of TypeDoc itself.
+Thank you for showing interest in contributing to this project. This guide provides some guidelines for doing so.
 
-## Contributions to the public docs
+If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help).
 
-Contributions to the public facing documentation hosted at https://typedoc-plugin-markdown.org welcome.
+## Contributing to the public docs
+
+Contributions to the public facing documentation hosted at https://typedoc-plugin-markdown.org is welcome.
 
 The site is built on [Nextra](https://nextra.site/docs) and you can edit the mdx files located at [docs folder](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/main/docs) of the repo.
 
 Please note that the API docs (`/pages/api-docs`) are autogenerated and should not be edited from the location.
 
-When submitting a PR please use commit message in the format `chore(docs): improved getting started docs`
+When submitting a PR please use commit message in the format `chore(docs): my docs update xxx`
 
 ## Contributing to the codebase
 
-For contributing to the plugin codebase, please see the [Developer Documentation](./developer-docs/README.md) for detailed information about the codebase and development practices.
-
-All contributions are welcome and appreciated. If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help).
+For contributing to the plugin codebase, please see the [Developer Guide](./devguide/README.md) for detailed information about the codebase and development practices.
 
-## Submitting a Pull Request
+## Submitting a PR
 
 Once you're ready to submit your changes:
 
@@ -45,8 +43,11 @@ Please note we follow [Conventional Commits](https://www.conventionalcommits.org
 
 The commit message should be in the form:
 
-`fix(core): resolve issue with table rendering (#100)`
+`fix(core): my bug fix xxx (#100)`
+
+The scope should be one of `'core'`, `'frontmatter'`, `'remark'`, `'docusaurus'`, `'vitepress'`, `'githubwiki'`, `'gitlabwiki'`, `'docs'`.
+Use `'core'` to contribute to the main project.
 
-## Contributors
+## Acknowledgements
 
 Thank you to all the people who have already contributed to typedoc-plugin-markdown.

developer-docs/README.md → devguide/README.md

@@ -1,4 +1,59 @@
-# Developer Documentation
+# Developer Guide
+
+## Contents
+
+* [Monorepo Overview](#monorepo-overview)
+* [Machine Setup](#machine-setup)
+* [Packages](#packages)
+
+## Monorepo Overview
+
+This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces).
+
+Please view individual packages for further insights:
+
+* [ typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) is the core package and is the package that is used to generate the markdown documentation.
+* [ typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) and [ typedoc-plugin-remark](typedoc-plugin-remark/README.md) provide metadata or adjust the output.
+* [ typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md), [ typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md),
+  [ typedoc-vitepress-theme](typedoc-vitepress-theme/README.md) and [ docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md) target specific implementations.
+
+## Machine Setup
+
+**1. Fork and clone the repository**
+
+Start by forking the repository to your own GitHub account. Then, clone the repository to your local machine. Please replace `<your-username>` with your actual GitHub username.
+
+```bash
+git clone git@github.com:<your-username>/typedoc-plugin-markdown.git
+```
+
+**2. Install dependencies**
+
+Navigate to the repository root and install the necessary dependencies:
+
+```bash
+cd typedoc-plugin-markdown
+
+npm install
+```
+
+**3. Build the packages and run tests**
+
+Finally, you can build all the packages and run the tests to ensure everything is set up correctly.
+
+Build all packages in the workspace:
+
+```bash
+npm run build
+```
+
+Test all packages in the workspace:
+
+```bash
+npm run test
+```
+
+If the project builds and the tests run successfully you are ready to start contributing to the project.
 
 ## Packages
 

developer-docs/docusaurus-plugin-typedoc/README.md → devguide/docusaurus-plugin-typedoc/README.md

@@ -1,15 +1,15 @@
-[Packages Index](../README.md) / docusaurus-plugin-typedoc
+[Home](../README.md) / docusaurus-plugin-typedoc
 
 # typedoc-vitepress-theme
 
 "typedoc-vitepress-theme" is a "theme" in the sense that it targets output for VitePress.
 
 ## Contents
 
-* [What does the package do?](#what-does-the-package-do)
+* [What Does the Package Do?](#what-does-the-package-do)
 * [Modules](#modules)
 
-## What does the package do?
+## What Does the Package Do?
 
 * Exposes some additional options to TypeDoc.
 * Presets relevant typedoc-plugin-markdown options.

developer-docs/docusaurus-plugin-typedoc/index/README.md → devguide/docusaurus-plugin-typedoc/index/README.md

@@ -1,4 +1,4 @@
-[Packages Index](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / index
+[Home](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / index
 
 # index
 
@@ -38,4 +38,4 @@
 
 ### Defined in
 
-[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13)
+[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13)

developer-docs/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md → devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md

@@ -1,4 +1,4 @@
-[Packages Index](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [index](../README.md) / PluginOptions
+[Home](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [index](../README.md) / PluginOptions
 
 # Interface: PluginOptions
 
@@ -105,7 +105,7 @@ Describes the options declared by the plugin.
 
 #### Defined in
 
-[docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/models.ts#L7)
+[docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/models.ts#L7)
 
 ***
 
@@ -121,7 +121,7 @@ Configures the autogenerated Docusaurus sidebar.
 
 #### Defined in
 
-[docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11)
+[docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11)
 
 ***
 

developer-docs/typedoc-vitepress-theme/options/README.md → devguide/docusaurus-plugin-typedoc/options/README.md

@@ -1,4 +1,4 @@
-[Packages Index](../../README.md) / [typedoc-vitepress-theme](../README.md) / options
+[Home](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / options
 
 # options
 

developer-docs/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md → devguide/docusaurus-plugin-typedoc/options/namespaces/declarations/README.md

@@ -1,4 +1,4 @@
-[Packages Index](../../../../README.md) / [docusaurus-plugin-typedoc](../../../README.md) / [options](../../README.md) / declarations
+[Home](../../../../README.md) / [docusaurus-plugin-typedoc](../../../README.md) / [options](../../README.md) / declarations
 
 # declarations
 
@@ -28,4 +28,4 @@ Please see the [sidebar guide](/plugins/docusaurus/guide/sidebar) for additional
 
 ### Defined in
 
-[docusaurus-plugin-typedoc/src/options/declarations.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/options/declarations.ts#L16)
+[docusaurus-plugin-typedoc/src/options/declarations.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/options/declarations.ts#L16)

developer-docs/docusaurus-plugin-typedoc/options/namespaces/presets/README.md → devguide/docusaurus-plugin-typedoc/options/namespaces/presets/README.md

@@ -1,4 +1,4 @@
-[Packages Index](../../../../README.md) / [docusaurus-plugin-typedoc](../../../README.md) / [options](../../README.md) / presets
+[Home](../../../../README.md) / [docusaurus-plugin-typedoc](../../../README.md) / [options](../../README.md) / presets
 
 # presets
 
@@ -18,4 +18,4 @@
 
 ### Defined in
 
-[docusaurus-plugin-typedoc/src/options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/options/presets.ts#L1)
+[docusaurus-plugin-typedoc/src/options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/options/presets.ts#L1)

developer-docs/typedoc-vitepress-theme/types/README.md → devguide/docusaurus-plugin-typedoc/types/README.md

@@ -1,4 +1,4 @@
-[Packages Index](../../README.md) / [typedoc-vitepress-theme](../README.md) / types
+[Home](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / types
 
 # types
 

developer-docs/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md → devguide/docusaurus-plugin-typedoc/types/interfaces/PluginOptions.md

@@ -1,4 +1,4 @@
-[Packages Index](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [types](../README.md) / PluginOptions
+[Home](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [types](../README.md) / PluginOptions
 
 # Interface: PluginOptions
 
@@ -24,4 +24,4 @@ Configures the autogenerated Docusaurus sidebar.
 
 #### Defined in
 
-[docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11)
+[docusaurus-plugin-typedoc/src/types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11)

devguide/docusaurus-plugin-typedoc/types/interfaces/Sidebar.md

@@ -0,0 +1,23 @@
+[Home](../../../README.md) / [docusaurus-plugin-typedoc](../../README.md) / [types](../README.md) / Sidebar
+
+# Interface: Sidebar
+
+## Properties
+
+### autoConfiguration
+
+> **autoConfiguration**: `boolean`
+
+#### Defined in
+
+[docusaurus-plugin-typedoc/src/types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L18)
+
+***
+
+### pretty
+
+> **pretty**: `boolean`
+
+#### Defined in
+
+[docusaurus-plugin-typedoc/src/types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/types/options.ts#L19)