Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document Bitbucket source linking and new githubPages options #40

Merged
merged 1 commit into from
Sep 18, 2021
Merged

Document Bitbucket source linking and new githubPages options #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 12 additions & 2 deletions guides/options.md
View file
Open in desktop
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