chore(all): updated dev docs

typedoc2md · Dec 30, 2024 · 28e23bc · 28e23bc
1 parent 591939c
commit 28e23bc
Show file tree

Hide file tree

Showing 136 changed files with 2,722 additions and 3,594 deletions.
diff --git a/.changeset/rare-pigs-drop.md b/.changeset/rare-pigs-drop.md
@@ -2,4 +2,4 @@
 'typedoc-plugin-markdown': minor
 ---
 
-- Always assign header ids to linkable symbols within table rows.
+- Always assign HTML anchor ids to linkable symbols within table rows.
diff --git a/.changeset/selfish-pens-live.md b/.changeset/selfish-pens-live.md
@@ -2,4 +2,4 @@
 'typedoc-plugin-markdown': patch
 ---
 
-- fix(core): Fix inline formatting of types when when "useCodeBlocks" is used (#742).
+- Fix inline formatting of types when when "useCodeBlocks" is used (#742).
diff --git a/devguide/README.md b/devguide/README.md
@@ -1,67 +1,19 @@
 # Developer Guide
 
-## Contents
+## Documents
 
-* [Monorepo Overview](#monorepo-overview)
-* [Machine Setup](#machine-setup)
-
-## 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.
+| Document | Description |
+| ------ | ------ |
+| [Getting Started](documents/Getting-Started.md) | How to start developing locally. |
 
 ## Packages
 
-| Name                                                               | Description                                                                                                              |
-| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
-| [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md)   | A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.                        |
-| [typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md)   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Github Wiki.                       |
-| [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md)   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Gitlab Wiki.                       |
-| [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content.               |
-| [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md)       | A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.                              |
-| [typedoc-plugin-remark](typedoc-plugin-remark/README.md)           | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that enables additional markdown transformations with remark plugins. |
-| [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md)       | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress.                         |
+| Package | Description |
+| ------ | ------ |
+| [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md) | A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown. |
+| [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content. |
+| [typedoc-plugin-remark](typedoc-plugin-remark/README.md) | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that enables additional markdown transformations with remark plugins. |
+| [typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Github Wiki. |
+| [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Gitlab Wiki. |
+| [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md) | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress. |
+| [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md) | A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project. |
diff --git a/devguide/documents/Getting-Started.md b/devguide/documents/Getting-Started.md
@@ -0,0 +1,53 @@
+[Developer Guide](../README.md) / Getting Started
+
+# Getting Started
+
+## 1. 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
+```
+
+## 2. Contributing to packages
+
+If the project builds and the tests run successfully you are ready to start contributing to the project.
+
+This is a simple monorepo managed by [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces).
+
+[typedoc-plugin-markdown](../typedoc-plugin-markdown/README.md) is the core package and is the package that is used to generate the Markdown documentation.
+
+Child packages all depend on the core package and provide further functionality:
+
+- [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.
diff --git a/devguide/docusaurus-plugin-typedoc/README.md b/devguide/docusaurus-plugin-typedoc/README.md
@@ -4,20 +4,16 @@
 
 "docusaurus-plugin-typedoc" is a Docusaurus plugin that bootstraps TypeDoc within the Docusaurus eco-system.
 
-## Contents
+Package features include:
 
-* [What Does the Package Do?](#what-does-the-package-do)
-
-## What Does the Package Do?
-
-* Presets relevant options of typedoc-plugin-markdown.
-* Bootstraps TypeDoc from the Docusaurus CLI.
-* Generates a sidebar file with configurable structure.
+- Presets relevant options of typedoc-plugin-markdown.
+- Bootstraps TypeDoc from the Docusaurus CLI.
+- Generates a sidebar file with configurable structure.
 
 ## Modules
 
-| Module                       | Description                                     |
-| ---------------------------- | ----------------------------------------------- |
-| [index](index/README.md)     | -                                               |
+| Module | Description |
+| ------ | ------ |
+| [core](core/README.md) | - |
 | [options](options/README.md) | All plugin types are exported from this module. |
-| [types](types/README.md)     | All plugin types are exported from this module. |
+| [types](types/README.md) | All plugin types are exported from this module. |
diff --git a/devguide/docusaurus-plugin-typedoc/core/README.md b/devguide/docusaurus-plugin-typedoc/core/README.md
@@ -0,0 +1,28 @@
+[Developer Guide](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / core
+
+# core
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. |
+
+## Functions
+
+### default()
+
+> **default**(`context`, `opts`): `Promise`\<\{ `name`: `string`; `extendCli`: `void`; \}\>
+
+Defined in: [docusaurus-plugin-typedoc/src/plugins/docusaurus.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/plugins/docusaurus.ts#L8)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `context` | `any` |
+| `opts` | `Partial`\<[`PluginOptions`](interfaces/PluginOptions.md)\> |
+
+#### Returns
+
+`Promise`\<\{ `name`: `string`; `extendCli`: `void`; \}\>