Skip to content

Commit

Permalink
chore(docs): docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Jun 18, 2024
1 parent 0f66d0e commit 79c966d
Show file tree
Hide file tree
Showing 134 changed files with 2,048 additions and 1,881 deletions.
2 changes: 1 addition & 1 deletion .prettierrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
"singleQuote": true,
"trailingComma": "all",
"plugins": ["prettier-plugin-organize-imports"]
}
}
37 changes: 19 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,36 @@
# Contributing Guide

Thank you for showing interest in contributing to this project. This guide provides some basic guidelines for doing so.
> How to contribute to "typedoc-plugin-markdown" and associated packages.
## 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](#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

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.
Thank you for showing interest in contributing to this project. This guide provides some guidelines for doing so.

## Contributions to the public docs
If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help).

Contributions to the public facing documentation hosted at https://typedoc-plugin-markdown.org welcome.
## Contributing to the public docs

Contributions to the public facing documentation hosted at https://typedoc-plugin-markdown.org is 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.

Please note that the API docs (`/pages/api-docs`) are autogenerated and should not be edited from the location.

When submitting a PR please use commit message in the format `chore(docs): improved getting started docs`
When submitting a PR please use commit message in the format `chore(docs): my docs update xxx`

## Contributing to the codebase

For contributing to the plugin codebase, please see the [Developer Documentation](./developer-docs/README.md) for detailed information about the codebase and development practices.

All contributions are welcome and appreciated. If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help).
For contributing to the plugin codebase, please see the [Developer Guide](./devguide/README.md) for detailed information about the codebase and development practices.

## Submitting a Pull Request
## Submitting a PR

Once you're ready to submit your changes:

Expand All @@ -45,8 +43,11 @@ Please note we follow [Conventional Commits](https://www.conventionalcommits.org

The commit message should be in the form:

`fix(core): resolve issue with table rendering (#100)`
`fix(core): my bug fix xxx (#100)`

The scope should be one of `'core'`, `'frontmatter'`, `'remark'`, `'docusaurus'`, `'vitepress'`, `'githubwiki'`, `'gitlabwiki'`, `'docs'`.
Use `'core'` to contribute to the main project.

## Contributors
## Acknowledgements

Thank you to all the people who have already contributed to typedoc-plugin-markdown.
29 changes: 0 additions & 29 deletions developer-docs/typedoc-plugin-markdown/documents/Testing.md

This file was deleted.

15 changes: 0 additions & 15 deletions developer-docs/typedoc-plugin-markdown/options/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion developer-docs/README.md → devguide/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Developer Documentation
# Developer Guide

## Packages

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

## Contents

* [What does the package do?](#what-does-the-package-do)
* [What Does the Package Do?](#what-does-the-package-do)
* [Modules](#modules)

## What does the package do?
## What Does the Package Do?

* Exposes some additional options to TypeDoc.
* Presets relevant typedoc-plugin-markdown options.
Expand Down
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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/plugin.ts#L13)
[docusaurus-plugin-typedoc/src/plugin.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/docusaurus-plugin-typedoc/src/models.ts#L7)
[docusaurus-plugin-typedoc/src/models.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/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/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/packages/docusaurus-plugin-typedoc/src/types/options.ts#L19)
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

## Contents

* [What does the package do?](#what-does-the-package-do)
* [What Does the Package Do?](#what-does-the-package-do)
* [Modules](#modules)

## What does the package do?
## What Does the Package Do?

* Exposes some additional options to TypeDoc.
* Presets relevant typedoc-plugin-markdown options.
Expand Down
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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/index.ts#L23)
[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/index.ts#L78)
[index.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/options/declarations.ts#L14)
[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/options/presets.ts#L1)
[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/types/options.ts#L11)
[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/types/options.ts#L18)
[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-github-wiki-theme/src/types/options.ts#L19)
[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/packages/typedoc-github-wiki-theme/src/types/options.ts#L19)
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

## Contents

* [What does the package do?](#what-does-the-package-do)
* [What Does the Package Do?](#what-does-the-package-do)
* [Modules](#modules)

## What does the package do?
## What Does the Package Do?

* Exposes some additional options to TypeDoc.
* Presets relevant typedoc-plugin-markdown options.
Expand Down
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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/index.ts#L23)
[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/options/declarations.ts#L14)
[options/declarations.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/options/presets.ts#L1)
[options/presets.ts:1](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L11)
[types/options.ts:11](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L18)
[types/options.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19)
[types/options.ts:19](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/packages/typedoc-gitlab-wiki-theme/src/types/options.ts#L19)
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

## Contents

* [What does the package do?](#what-does-the-package-do)
* [What Does the Package Do?](#what-does-the-package-do)
* [Modules](#modules)

## What does the package do?
## What Does the Package Do?

* Exposes some additional options to TypeDoc.
* Prepends a YAML block to pages.
Expand Down
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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/index.ts#L18)
[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15)
[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24)
[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33)
[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61)
[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66)
[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/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/352ce41370cee18034e72b7c2f3874bbfe56f96f/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)
[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/6f9fadfe9c77b7de4adbc0130bcb45bef15340d9/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)
Loading

0 comments on commit 79c966d

Please sign in to comment.