chore(docs): started contributing docs

CONTRIBUTING.md

@@ -1,58 +1,15 @@
 # Contributing Guide
 
 Thank you for showing interest in contributing to this project. This guide provides some basic guidelines for doing so.
+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.
 
-## Overview
+## Developer Documentation
 
-This project attempts to align with TypeDoc core as much as possible. Before you start, you might find it helpful to read the TypeDoc development guide to understand the architecture of TypeDoc itself.
+Please see the [developer documentation](./developer-docs#read-me) for autogenerated docs generated by this plugin, including associated supporting documents.
 
-## Machine Setup
+## Submitting a Pull Request
 
-This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces).
-
-**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.
-
-## Developing
-
-Once setup you can start to develop. Please select the package you would like to contribute to to view the auto-generated developer docs.
-
-- [typedoc-plugin-markdown](./packages/typedoc-plugin-markdown/developer-docs#readme)
-
-## Submitting a PR
+Once you are ready to submit your changes please create a PR into the `main` branch.
 
 ## Contributors
 

developer-docs/README.md

@@ -0,0 +1,11 @@
+# Developer Documentation
+
+Please select the package you would like to view documentation for:  
+
+
+## Packages
+
+| Name | Version | Description |
+| ------ | ------ | ------ |
+| [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) | 4.0.3 | A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown. |
+| [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) | 1.0.0 | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content. |

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

@@ -0,0 +1,25 @@
+[Packages Index](../README.md) / typedoc-plugin-frontmatter
+
+# typedoc-plugin-frontmatter
+
+Docs for `lib` module
+
+## Functions
+
+### load()
+
+> **load**(`app`): `void`
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/dfbe68a47044812c56cc2eda4f16f4a68956473e/packages/typedoc-plugin-frontmatter/src/index.ts#L18)

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

@@ -0,0 +1,13 @@
+[Packages Index](../README.md) / typedoc-plugin-markdown
+
+# typedoc-plugin-markdown
+
+## Modules
+
+| Module | Description |
+| ------ | ------ |
+| [app](app/README.md) | Contains all the events and overrides of the typedoc Application. |
+| [options](options/README.md) | Configures plugin options. |
+| [internationalization](internationalization/README.md) | Exposes additional i18n keys and translations used by the theme. |
+| [theme](theme/README.md) | This is the built-in Markdown theme. |
+| [libs](libs/README.md) | General pure library functions to be consumed across the plugin. |

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

@@ -0,0 +1,16 @@
+[Packages Index](../../README.md) / [typedoc-plugin-markdown](../README.md) / app
+
+# app
+
+Contains all the events and overrides of the typedoc Application.
+
+## Index
+
+### Namespaces
+
+| Namespace | Description |
+| ------ | ------ |
+| [initialize](namespaces/initialize/README.md) | Initialization and bootstrapping of the plugin. |
+| [events](namespaces/events/README.md) | Contains all the events and overrides of the typedoc Application. |
+| [renderer](namespaces/renderer/README.md) | Contains override methods to decouple HTML logic from the TypeDoc's Renderer} |
+| [types](namespaces/types/README.md) | Types used for the app. |

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

@@ -0,0 +1,14 @@
+[Packages Index](../../../../README.md) / [typedoc-plugin-markdown](../../../README.md) / [app](../../README.md) / events
+
+# events
+
+Contains all the events and overrides of the typedoc Application.
+
+## Index
+
+### Classes
+
+| Class | Description |
+| ------ | ------ |
+| [MarkdownPageEvent](classes/MarkdownPageEvent.md) | An event emitted by before and after the markup of a page is rendered. |
+| [MarkdownRendererEvent](classes/MarkdownRendererEvent.md) | An event emitted at the beginning and end of the rendering process. |