Skip to content

Commit

Permalink
chore(docs): updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Sep 22, 2024
1 parent 626b826 commit 974a60d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
17 changes: 9 additions & 8 deletions docs/pages/docs/typedoc-usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,15 @@ TypeDoc's [Output](https://typedoc.org/options/output/) options are used by the

Below is a list of which TypeDoc Output options are supported:

- `--out` Yes ✅
- `--navigation` Yes ✅ ([See Utilizing Navigation](/api-docs/Document.Utilizing-Navigation))
- `--theme` Yes ✅ (theme should be MarkdownTheme instance)
- `--cleanOutputDir` Yes ✅
- `--lang` Yes ✅
- `--locale` Yes ✅
- `--basePath` Yes ✅
- `--githubPages` Yes ✅ (defaults to `false`)
- [`--out`](https://typedoc.org/options/output/#out) Yes ✅
- [`--navigation`](https://typedoc.org/options/output/#navigation) Yes ✅ ([See Utilizing Navigation](/api-docs/Document.Utilizing-Navigation))
- [`--theme`](https://typedoc.org/options/output/#theme) Yes ✅ (theme should be MarkdownTheme instance)
- [`--cleanOutputDir`](https://typedoc.org/options/output/#cleanoutputdir) Yes ✅
- [`--lang`](https://typedoc.org/options/output/#lang) Yes ✅
- [`--locale`](https://typedoc.org/options/output/#locale) Yes ✅
- [`--basePath`](https://typedoc.org/options/output/#basepath) Yes ✅
- [`--githubPages`](https://typedoc.org/options/output/#githubpages) Yes ✅ (defaults to `false`)
- `--hostedBaseUrl` & `--useHostedBaseUrlForAbsoluteLinks` No ❌ (use <OptionLink type="utility" name="publicPath" />)
- `--hideParameterTypesInTitle` No ❌ (use <OptionLink type="display" name="expandParameters" />)
- `--titleLink` No ❌
- `--navigationLinks` No ❌
Expand Down
2 changes: 1 addition & 1 deletion packages/typedoc-plugin-markdown/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## 4.2.8
## 4.2.8 (2024-09-22)

### Patch Changes

Expand Down

0 comments on commit 974a60d

Please sign in to comment.