Skip to content

Commit

Permalink
Merge pull request #40 from srmagura/new-options
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit0 committed Sep 18, 2021
2 parents 9ea6bd2 + 5193162 commit 29fc6df
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions guides/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,18 +336,28 @@ The available sorting strategies are:
$ typedoc --gitRevision <revision|branch>
```

Use specified revision or branch instead of the last revision for linking to GitHub source files.
Use specified revision or branch instead of the last revision for linking to GitHub/Bitbucket source files.

### gitRemote

```bash
$ typedoc --gitRemote <remote>
```

Use the specified git remote instead of `origin` for linking to GitHub source files.
Use the specified git remote instead of `origin` for linking to GitHub/Bitbucket source files.
You can use `git remote` to view a list of valid remotes.
If you are updating documentation for a forked package, you probably want to pass `--gitRemote upstream`.

### githubPages

```bash
$ typedoc --githubPages false
```

When enabled, automatically add a `.nojekyll` file to the output directory to prevent GitHub Pages
from processing your documentation site using Jekyll. If you have scoped packages, TypeDoc
generates HTML files that start with `_` which are ignored by Jekyll. Defaults to `true`.

### gaID

```bash
Expand Down

0 comments on commit 29fc6df

Please sign in to comment.