chore(docs): documentation updates

CONTRIBUTING.md

@@ -6,7 +6,7 @@ Before you start, you might find it helpful to read the [TypeDoc development gui
 
 ## Contributions to the public docs
 
-Contribute to the public facing documentation hosted at https://typedoc-plugin-markdown.org is welcome.
+Contributions to the public facing documentation hosted at https://typedoc-plugin-markdown.org 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.
 
@@ -16,24 +16,18 @@ When submitting a PR please use commit message in the format `chore(docs): impro
 
 ## Contributing to the codebase
 
-If you're interested in contributing code, here's how you can get started:
+For contributing to the plugin codebase, please see the [Developer Documentation](./developer-docs/README.md) for detailed information about the codebase and development practices.
 
-1. **Fork and Clone**: Fork the repository and clone it to your local machine.
-   - Use `git clone https://github.com/typedoc2md/typedoc-plugin-markdown.git` to clone your fork.
-2. **Install Dependencies**: Run `npm install` to install the necessary dependencies.
-3. **Create a Branch**: Create a new branch for your work using git checkout -b branch-name.
-4. **Make Your Changes**: For contributing to the plugin codebase, please see the [Developer Documentation](./developer-docs/README.md) for detailed information about the codebase and development practices.
-
-If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help).
+All contributions are welcome and appreciated. If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help).
 
 ## Submitting a Pull Request
 
 Once you're ready to submit your changes:
 
-- **Push your branch**: Push your branch to your forked repository on GitHub.
-- **Create a PR**: Navigate to the original repository and create a PR from your branch to the main branch.
-- **Provide a clear description**: Include a detailed description of your changes, why they're necessary, and any issues they resolve.
-- **Link to relevant issues**: If your PR addresses any open issues, mention them in the description.
+* **Push your branch**: Push your branch to your forked repository on GitHub.
+* **Create a PR**: Navigate to the original repository and create a PR from your branch to the main branch.
+* **Provide a clear description**: Include a detailed description of your changes, why they're necessary, and any issues they resolve.
+* **Link to relevant issues**: If your PR addresses any open issues, mention them in the description.
 
 Please note we follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
 

README.md

@@ -18,14 +18,14 @@ This project is a collection of packages designed for generate TypeScript API do
 
 Please see [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org).
 
-## Examples
-
-Please see the [examples repository](https://github.com/typedoc2md/typedoc-plugin-markdown-examples).
-
 ## Contributing
 
 If you would like to contribute towards this project please read the [contributing guide](./CONTRIBUTING.md).
 
+## Examples
+
+Please see the [examples repository](https://github.com/typedoc2md/typedoc-plugin-markdown-examples).
+
 ## License
 
 Released under the [MIT License](./LICENSE).

developer-docs/README.md

@@ -1,7 +1,5 @@
 # Developer Documentation
 
-This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces). It consists of the core package **"typedoc-plugin-markdown"** and other related packages providing additional functionality.
-
 ## Packages
 
 | Name                                                               | Version | Description                                                                                                |

developer-docs/typedoc-plugin-frontmatter/app/namespaces/initialize/README.md

@@ -25,4 +25,4 @@
 
 #### Defined in
 
-[app/initialize.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/app/initialize.ts#L13)
+[app/initialize.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/app/initialize.ts#L13)

developer-docs/typedoc-plugin-frontmatter/app/namespaces/tags/README.md

@@ -27,7 +27,7 @@
 
 #### Defined in
 
-[app/tags.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L4)
+[app/tags.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L4)
 
 ***
 
@@ -49,4 +49,4 @@
 
 #### Defined in
 
-[app/tags.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L28)
+[app/tags.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L28)

developer-docs/typedoc-plugin-frontmatter/options/README.md

@@ -8,8 +8,8 @@ Configures plugin options.
 
 ### Namespaces
 
-| Namespace                                         | Description                                   |
-| ------------------------------------------------- | --------------------------------------------- |
-| [declarations](namespaces/declarations/README.md) | -                                             |
-| [maps](namespaces/maps/README.md)                 | -                                             |
-| [types](namespaces/types/README.md)               | Describes the options declared by the plugin. |
+| Namespace                                         | Description |
+| ------------------------------------------------- | ----------- |
+| [declarations](namespaces/declarations/README.md) | -           |
+| [maps](namespaces/maps/README.md)                 | -           |
+| [types](namespaces/types/README.md)               | -           |

developer-docs/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md

@@ -43,7 +43,7 @@ sidebar: true
 
 #### Defined in
 
-[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15)
+[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15)
 
 ***
 
@@ -69,7 +69,7 @@ sidebar: true
 
 #### Defined in
 
-[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24)
+[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24)
 
 ***
 
@@ -95,7 +95,7 @@ sidebar: true
 
 #### Defined in
 
-[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33)
+[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33)
 
 ***
 
@@ -139,7 +139,7 @@ description: A description that will be added to frontmatter.
 
 #### Defined in
 
-[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61)
+[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61)
 
 ***
 
@@ -159,7 +159,7 @@ description: A description that will be added to frontmatter.
 
 #### Defined in
 
-[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66)
+[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66)
 
 ***
 
@@ -184,4 +184,4 @@ This option can configure the output style of frontmatter variables when written
 
 #### Defined in
 
-[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)
+[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)

developer-docs/typedoc-plugin-frontmatter/options/namespaces/types/README.md

@@ -2,8 +2,6 @@
 
 # types
 
-Describes the options declared by the plugin.
-
 ## Contents
 
 * [Index](#index)
@@ -22,6 +20,6 @@ Describes the options declared by the plugin.
 
 ### Other
 
-| Interface                                    | Description |
-| -------------------------------------------- | ----------- |
-| [PluginOptions](interfaces/PluginOptions.md) | -           |
+| Interface                                    | Description                                   |
+| -------------------------------------------- | --------------------------------------------- |
+| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. |

developer-docs/typedoc-plugin-frontmatter/options/namespaces/types/interfaces/PluginOptions.md

@@ -2,6 +2,8 @@
 
 # Interface: PluginOptions
 
+Describes the options declared by the plugin.
+
 ## Contents
 
 * [Properties](#properties)
@@ -22,7 +24,7 @@ Specify which comment block tags should be added to frontmatter.
 
 #### Defined in
 
-[options/types.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/types.ts#L14)
+[options/types.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/types.ts#L16)
 
 ***
 
@@ -34,7 +36,7 @@ Specify static variables to be added to all frontmatter blocks.
 
 #### Defined in
 
-[options/types.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/types.ts#L19)
+[options/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/types.ts#L21)
 
 ***
 
@@ -46,7 +48,7 @@ The naming convention that variables should be output as.
 
 #### Defined in
 
-[options/types.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/types.ts#L24)
+[options/types.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/types.ts#L26)
 
 ***
 
@@ -58,7 +60,7 @@ Specify static variables to be added to the index page only.
 
 #### Defined in
 
-[options/types.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/types.ts#L29)
+[options/types.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/types.ts#L31)
 
 ***
 
@@ -70,7 +72,7 @@ Preserve tags defined in frontmatter block tags in output.
 
 #### Defined in
 
-[options/types.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/types.ts#L34)
+[options/types.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/types.ts#L36)
 
 ***
 
@@ -82,4 +84,4 @@ Specify static variables to be added to the readme page only.
 
 #### Defined in
 
-[options/types.ts:39](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-frontmatter/src/options/types.ts#L39)
+[options/types.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/types.ts#L41)

developer-docs/typedoc-plugin-markdown/README.md

@@ -2,7 +2,7 @@
 
 # typedoc-plugin-markdown
 
-"typedoc-plugin-markdown" is the core package of this monorepo and is the package that is used to generate the markdown documentation:
+The core package of this monorepo and is the package that is used to generate the markdown documentation.
 
 ## What does the package do?
 
@@ -13,10 +13,10 @@
 
 ## Documents
 
-| Document                                                                    | Description                                                            |
-| --------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
-| [Internationalization Guidance](documents/Internationalization-Guidance.md) | How to edit or add a new locale to custom plugin translatable strings. |
-| [Testing guide](documents/Testing-guide.md)                                 | Guidance of running tests and creating fixtures.                       |
+| Document                                        | Description                                      |
+| ----------------------------------------------- | ------------------------------------------------ |
+| [Getting Started](documents/Getting-Started.md) | Instructions on how to start developing locally. |
+| [Testing](documents/Testing.md)                 | Guidance of running tests and creating fixtures. |
 
 ## Modules
 

developer-docs/typedoc-plugin-markdown/app/namespaces/events/classes/MarkdownPageEvent.md

@@ -59,7 +59,7 @@ The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflecti
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L22)
+[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L22)
 
 ***
 
@@ -72,7 +72,7 @@ Either a [`DeclarationReflection`](https://typedoc.org/api/classes/Models.Declar
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L28)
+[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L28)
 
 ***
 
@@ -86,7 +86,7 @@ Should be rendered by layout templates and can be modified by plugins.
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L35)
+[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L35)
 
 ***
 
@@ -98,7 +98,7 @@ The url `string` of the page.
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L40)
+[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L40)
 
 ***
 
@@ -110,7 +110,7 @@ The complete `string` filename where the file will be written..
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L45)
+[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L45)
 
 ***
 
@@ -122,7 +122,7 @@ The frontmatter of this page represented as a key value object. This property ca
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L50)
+[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L50)
 
 ## Accessors
 
@@ -226,7 +226,7 @@ Triggered before a document will be rendered.
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L62)
+[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L62)
 
 ***
 
@@ -238,4 +238,4 @@ Triggered after a document has been rendered, just before it is written to disc.
 
 #### Defined in
 
-[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6040ac7ed52761100f65c71074bb38fe47f3aa71/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L68)
+[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L68)