Skip to content

Commit

Permalink
fix: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Aug 24, 2023
1 parent 36dab07 commit 6839867
Show file tree
Hide file tree
Showing 12 changed files with 390 additions and 957 deletions.
97 changes: 49 additions & 48 deletions packages/typedoc-plugin-markdown/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
# typedoc-plugin-markdown

![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown%2Fnext?\&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)

> **Please note this pre-release version may contain breaking changes within the same semantic version.**
A plugin for [TypeDoc](https://typedoc.org) that renders TypeScript API documentation as Markdown.

## Contents

- [What does it do?](#what-does-it-do)
- [Installation](#installation)
- [Usage](#usage)
- [Plugin Options](#plugin-options)
- [Customization](#customization)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)
* [What does it do?](#what-does-it-do)
* [Installation](#installation)
* [Usage](#usage)
* [Plugin Options](#plugin-options)
* [Custom templates](#custom-templates)
* [Contributing](#contributing)
* [License](#license)

## What does it do?

Expand All @@ -31,67 +30,69 @@ npm install typedoc typedoc-plugin-markdown@next --save-dev

## Usage

Specify the using the `plugin` configuration option.
### How to load the plugin?

Plugins are loaded by using the `plugin` configuration option:

Via the command line.

```bash
typedoc --plugin typedoc-plugin-markdown
```

This guide assumes familarity with TypeDoc and please refer to [TypeDoc documenation](https://typedoc.org/guides/installation/) on how to use TypeDoc in general.

Please note:
Using a `typedoc.json` config file or under the `typedocOptions` key in `tsconfig.json`.

- All of TypeDoc's [Configuration](https://typedoc.org/options/configuration/), [Input](https://typedoc.org/options/input/) and [Organization](https://typedoc.org/options/organization/) options are all respected as these are executed at the conversion phase of the project.
```json
{ "plugin": ["typedoc-plugin-markdown"] }
```

- TypeDoc's [Output](https://typedoc.org/options/output/) options are relevant to the rendering phase and are HTML output specific and are ignored by this plugin with the exception of [`--cleanOutputDir`]().
Please see <https://typedoc.org/options/configuration> for general TypeDoc option configuration.

## Options
### What TypeDoc options are supported?

Additional [Output](./docs/guides/options/output.md), [Frontmatter](./docs/guides/options/ui.md) and [Remark](./docs/guides/options/utility.md) options exposed by this plugin.
* All of TypeDoc's [Configuration](https://typedoc.org/options/configuration/), [Input](https://typedoc.org/options/input/) and [Organization](https://typedoc.org/options/organization/) options are all respected as these are executed at the conversion phase of the project.

### File Options
* TypeDoc's [Output](https://typedoc.org/options/output/) options are relevant to the rendering phase and in the main HTML output specific and are ignored by this plugin with the exception of [`--out`]() and [`--cleanOutputDir`]().

Options which control how output files are generated.
## Plugin Options

- [`--outputFileStrategy`]()
- [`--includeFileNumberPrefixes`]()
- [`--flattenOutputFiles`]()
- [`--entryFileName`]()
- [`--indexFileName`]()
- [`--indexPageTitle`]()
- [`--skipIndexPage`]()
This plugin exposes additional options. Please see [Options Guide](./docs/guides/options.md) for detailed usage.

### UI Options
### Output Options

Options which control the format of the output on the page.
Options that define how output files are generated.

- [`--excludeGroups`]()
- [`--hidePageHeader`]()
- [`--hidePageTitle`]()
- [`--hideBreadcrumbs`]()
- [`--hideInPageTOC`]()
- [`--hideHierarchy`]()
- [`--identifiersAsCodeBlocks`]()
- [`--propertiesFormat`]()
- [`--enumMembersFormat`]()
- [`--typeDeclarationFormat`]()
- [`--tocFormat`]()
- [`--titleTemplate`]()
* [`--outputFileStrategy`]()
* [`--includeFileNumberPrefixes`]()
* [`--flattenOutputFiles`]()
* [`--entryFileName`]()
* [`--indexFileName`]()
* [`--indexPageTitle`]()
* [`--skipIndexPage`]()
* [`--preserveAnchorCasing`]()
* [`--anchorPrefix`]()

### Utility Options
### UI Options

- [`--remarkPlugins`]()
- [`--translations`]()
- [`--preserveAnchorCasing`]()
UI Options

* [`--excludeGroups`](./docs/guides/options.md#--excludegroups)
* [`--hidePageHeader`](./docs/guides/options.md#--hidepageheader)
* [`--hidePageTitle`](./docs/guides/options.md#--hidepagetitle)
* [`--hideBreadcrumbs`](./docs/guides/options.md#--hidebreadcrumbs)
* [`--hideInPageTOC`](./docs/guides/options.md#--hideinpagetoc)
* [`--hideHierarchy`](./docs/guides/options.md#--hidehierarchy)
* [`--identifiersAsCodeBlocks`](./docs/guides/options.md#--identifiersascodeblocks)
* [`--propertiesFormat`](./docs/guides/options.md#--propertiesformat)
* [`--enumMembersFormat`](./docs/guides/options.md#--enummembersformat)
* [`--typeDeclarationFormat`](./docs/guides/options.md#--typedeclarationformat)
* [`--tocFormat`](./docs/guides/options.md#--tocformat)
* [`--titleTemplate`](./docs/guides/options.md#--titletemplate)

## Custom templates

Coming soon

## Examples

Coming soon

## Contributing

Contributions and suggestions are welcome. Please see the [contributing guidelines](CONTRIBUTING.md) for further details.
Expand Down
Loading

0 comments on commit 6839867

Please sign in to comment.