Skip to content

Commit

Permalink
chore(docs): documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Jun 21, 2024
1 parent 9b92507 commit c08cc3f
Show file tree
Hide file tree
Showing 66 changed files with 287 additions and 459 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
## Contents

- [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](#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

Expand All @@ -34,10 +34,10 @@ For contributing to the plugin codebase, please see the [Developer Guide](./devg

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.

Expand Down
2 changes: 1 addition & 1 deletion devguide/docusaurus-plugin-typedoc/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@

### Defined in

[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13)
[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13)
Original file line number Diff line number Diff line change
Expand Up @@ -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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/docusaurus-plugin-typedoc/src/models.ts#L7)
[docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/models.ts#L7)

***

Expand All @@ -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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11)

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/main/packages/docusaurus-plugin-typedoc/src/options/declarations.ts#L16)
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@

### Defined in

[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)
[docusaurus-plugin-typedoc/src/options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/options/presets.ts#L1)
Original file line number Diff line number Diff line change
Expand Up @@ -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/7934b23566f374f44fe6de5fd9240ab185bf799f/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/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L11)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#### 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)
[docusaurus-plugin-typedoc/src/types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L18)

***

Expand All @@ -20,4 +20,4 @@
#### 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)
[docusaurus-plugin-typedoc/src/types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/src/types/options.ts#L19)
4 changes: 2 additions & 2 deletions devguide/typedoc-github-wiki-theme/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The plugin entrypoint and bootstrapping of the plugin.

### Defined in

[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/index.ts#L23)
[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L23)

***

Expand All @@ -45,4 +45,4 @@ The plugin entrypoint and bootstrapping of the plugin.

### Defined in

[index.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/index.ts#L78)
[index.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L78)
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The heading displayed above the sidebar.

### Defined in

[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14)
[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14)
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@

### Defined in

[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1)
[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1)
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Configures the autogenerated `_sidebar.md file`.

#### Defined in

[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/types/options.ts#L11)
[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L11)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#### Defined in

[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/types/options.ts#L18)
[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L18)

***

Expand All @@ -20,4 +20,4 @@
#### Defined in

[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-github-wiki-theme/src/types/options.ts#L19)
[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/types/options.ts#L19)
2 changes: 1 addition & 1 deletion devguide/typedoc-gitlab-wiki-theme/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ The plugin entrypoint and bootstrapping of the plugin.

### Defined in

[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/index.ts#L23)
[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/index.ts#L23)
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The heading displayed above the sidebar.

### Defined in

[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14)
[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14)
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@

### Defined in

[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1)
[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1)
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Configures the autogenerated `_Sidebar.md file`.

#### Defined in

[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L11)
[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L11)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#### Defined in

[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L18)
[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L18)

***

Expand All @@ -20,4 +20,4 @@
#### Defined in

[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19)
[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19)
2 changes: 1 addition & 1 deletion devguide/typedoc-plugin-frontmatter/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ The plugin entrypoint and bootstrapping of the plugin.

### Defined in

[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/index.ts#L18)
[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/index.ts#L18)
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sidebar: true

### Defined in

[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15)
[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15)

***

Expand All @@ -66,7 +66,7 @@ sidebar: true

### Defined in

[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24)
[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24)

***

Expand All @@ -92,7 +92,7 @@ sidebar: true

### Defined in

[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33)
[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33)

***

Expand Down Expand Up @@ -136,7 +136,7 @@ description: A description that will be added to frontmatter.

### Defined in

[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61)
[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61)

***

Expand All @@ -156,7 +156,7 @@ description: A description that will be added to frontmatter.

### Defined in

[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66)
[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66)

***

Expand All @@ -181,4 +181,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/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)
[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)
4 changes: 2 additions & 2 deletions devguide/typedoc-plugin-frontmatter/tags/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Functionality to map options to tags.

### Defined in

[tags.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/tags.ts#L9)
[tags.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L9)

***

Expand All @@ -48,4 +48,4 @@ Functionality to map options to tags.

### Defined in

[tags.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/tags.ts#L33)
[tags.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L33)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Specify which comment block tags should be added to frontmatter.

#### Defined in

[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L11)
[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L11)

***

Expand All @@ -26,7 +26,7 @@ Specify static variables to be added to all frontmatter blocks.

#### Defined in

[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L16)
[types/options.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L16)

***

Expand All @@ -38,7 +38,7 @@ The naming convention that variables should be output as.

#### Defined in

[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L21)
[types/options.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L21)

***

Expand All @@ -50,7 +50,7 @@ Specify static variables to be added to the index page only.

#### Defined in

[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L26)
[types/options.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L26)

***

Expand All @@ -62,7 +62,7 @@ Preserve tags defined in frontmatter block tags in output.

#### Defined in

[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L31)
[types/options.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L31)

***

Expand All @@ -74,4 +74,4 @@ Specify static variables to be added to the readme page only.

#### Defined in

[types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/7934b23566f374f44fe6de5fd9240ab185bf799f/packages/typedoc-plugin-frontmatter/src/types/options.ts#L36)
[types/options.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/types/options.ts#L36)
Loading

0 comments on commit c08cc3f

Please sign in to comment.