Skip to content

Commit

Permalink
Add options from v0.25.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit0 committed Sep 4, 2023
1 parent c022442 commit d31de9e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
2 changes: 2 additions & 0 deletions options/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Options which control how input is converted into a project.
- [excludePrivate](/options/input/#excludeprivate)
- [excludeProtected](/options/input/#excludeprotected)
- [excludeReferences](/options/input/#excludereferences)
- [excludeCategories](/options/input/#excludecategories)
- [name](/options/input/#name)
- [includeVersion](/options/input/#includeversion)
- [disableSources](/options/input/#disablesources)
Expand All @@ -49,6 +50,7 @@ Options which control how input is converted into a project.
- [gitRemote](/options/input/#gitremote)
- [disablegit](/options/input/#disablegit)
- [readme](/options/input/#readme)
- [stripYamlFrontmatter](/options/input/#stripyamlfrontmatter)

## Output Options

Expand Down
16 changes: 16 additions & 0 deletions options/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,14 @@ $ typedoc --excludeReferences

Removes re-exports of a symbol already included in the documentation from the documentation. Defaults to false.

## excludeCategories

```bash
$ typedoc --excludeCategories A --excludeCategories B
```

Removes reflections associated with any of the given categories.

## name

```bash
Expand Down Expand Up @@ -233,3 +241,11 @@ $ typedoc --readme <path/to/readme|none>
```

Path to the readme file that should be displayed on the index page. If no readme is discovered or read, the index page will be disabled.

## stripYamlFrontmatter

```bash
$ typedoc --stripYamlFrontmatter
```

Remove YAML frontmatter from the readme file displayed on the main page.

0 comments on commit d31de9e

Please sign in to comment.