chore(core): code documentation updates

typedoc2md · Jun 17, 2024 · 77cf5bf · 77cf5bf
1 parent 212ec76
commit 77cf5bf
Show file tree

Hide file tree

Showing 248 changed files with 5,689 additions and 6,535 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,6 +2,18 @@
 
 Thank you for showing interest in contributing to this project. This guide provides some basic guidelines for doing so.
 
+## 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
+
 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.
 
 ## Contributions to the public docs
@@ -24,10 +36,10 @@ All contributions are welcome and appreciated. If something does not make sense
 
 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.
 

diff --git a/developer-docs/README.md b/developer-docs/README.md
@@ -2,7 +2,12 @@
 
 ## 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. |
+| 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.               |
+| [typedoc-plugin-remark](typedoc-plugin-remark/README.md)           | 1.0.1   | 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)   | 2.0.0   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Github Wiki.                       |
+| [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md)   | 2.0.1   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Gitlab Wiki.                       |
+| [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md)       | 1.0.0   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress.                         |
+| [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md)   | 1.0.1   | A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.                        |
diff --git a/developer-docs/docusaurus-plugin-typedoc/README.md b/developer-docs/docusaurus-plugin-typedoc/README.md
@@ -0,0 +1,24 @@
+[Packages Index](../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)
+* [Modules](#modules)
+
+## What does the package do?
+
+* Exposes some additional options to TypeDoc.
+* Presets relevant typedoc-plugin-markdown options.
+* Generates a sidebar json file.
+
+## Modules
+
+| Module                       | Description                                     |
+| ---------------------------- | ----------------------------------------------- |
+| [index](index/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. |
diff --git a/developer-docs/docusaurus-plugin-typedoc/index/README.md b/developer-docs/docusaurus-plugin-typedoc/index/README.md
@@ -0,0 +1,41 @@
+[Packages Index](../../README.md) / [docusaurus-plugin-typedoc](../README.md) / index
+
+# index
+
+## Contents
+
+* [Index](#index-1)
+  * [Interfaces](#interfaces)
+* [default()](#default)
+
+## Index
+
+### Interfaces
+
+| Interface                                    | Description                                   |
+| -------------------------------------------- | --------------------------------------------- |
+| [PluginOptions](interfaces/PluginOptions.md) | Describes the options declared by the plugin. |
+
+## default()
+
+> **default**(`context`, `opts`): `Promise`\<`object`>
+
+### Parameters
+
+| Parameter | Type                                                       |
+| --------- | ---------------------------------------------------------- |
+| `context` | `any`                                                      |
+| `opts`    | `Partial`\<[`PluginOptions`](interfaces/PluginOptions.md)> |
+
+### Returns
+
+`Promise`\<`object`>
+
+| Name        | Type     | Default value |
+| ----------- | -------- | ------------- |
+| `name`      | `string` | PLUGIN\_NAME  |
+| `extendCli` | `void`   | -             |
+
+### 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)