Skip to content

Commit

Permalink
docs: clarify how dst and src options are applied via gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
antongolub committed Dec 7, 2024
1 parent cb8ff23 commit c14650b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ or even shorter if default settings are used:
| Option | Description | Default |
|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| `msg` | Commit message template | `docs updated <%= nextRelease.gitTag %>` |
| `src` | Documentation directory | `docs`<br/><br/>**NOTE** don't forget to run docs builder (`yarn docs`, `yarn typedoc`, etc) as a part of your build step or any other way |
| `dst` | Destination directory | `.` (root) |
| `src` | Documentation directory. Used as gh-pages [dir](https://github.com/tschaub/gh-pages?tab=readme-ov-file#dir) | `docs`<br/><br/>**NOTE** don't forget to run docs builder (`yarn docs`, `yarn typedoc`, etc) as a part of your build step or any other way |
| `dst` | Destination directory. gh-pages [dest](https://github.com/tschaub/gh-pages?tab=readme-ov-file#optionsdest) | `.` (root) |
| `branch` | Docs branch to push | `gh-pages` |
| `branches` | Optional list of src-to-target branches association. If defined it suppresses `branch` option. For example, `[['master', 'gh-pages'], ['beta', beta-docs]]` | undefined |
| `repositoryUrl` | Repository url | inherited from .git |
Expand Down

0 comments on commit c14650b

Please sign in to comment.