Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit fecd937

Browse files
BogayLee-W
authored andcommitted
docs: replace htperlinks' URL with filename
According to mkdoc documentation, link to another page in the same documentation can directly use file path. mkdoc documentation: https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages 
1 parent a3ce69f commit fecd937

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

‎docs/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ After the configuration is added, you'll need to run
106106
pre-commit install --hook-type commit-msg
107107
```
108108

109-
Read more about the `check` command [here](https://commitizen-tools.github.io/commitizen/check/).
109+
Read more about the `check` command [here](check.md).
110110

111111
### Help
112112

@@ -175,7 +175,7 @@ See [Third-Party Commitizen Templates](third-party-commitizen.md).
175175

176176
## FAQ
177177

178-
See [FAQ - commitizen](https://commitizen-tools.github.io/commitizen/faq/).
178+
See [FAQ](faq.md).
179179

180180
## Contributing
181181

‎docs/config.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@ commitizen:
134134
| `customize` | `dict` | `None` | **This is only supported when config through `toml`.** Custom rules for committing and bumping. [See more](customization) |
135135
| `use_shortcuts` | `bool` | `false` | If enabled, commitizen will show keyboard shortcuts when selecting from a list. Define a `key` for each of your choices to set the key. [See more](shortcuts) |
136136

137-
[version_files]: https://commitizen-tools.github.io/commitizen/bump/#version_files
138-
[tag_format]: https://commitizen-tools.github.io/commitizen/bump/#tag_format
139-
[bump_message]: https://commitizen-tools.github.io/commitizen/bump/#bump_message
137+
[version_files]: bump.md#version_files
138+
[tag_format]: bump.md#tag_format
139+
[bump_message]: bump.md#bump_message
140140
[additional-features]: https://github.com/tmbo/questionary#additional-features
141-
[customization]: https://commitizen-tools.github.io/commitizen/customization/
142-
[shortcuts]: https://commitizen-tools.github.io/commitizen/customization/#shortcut-keys
141+
[customization]: customization.md
142+
[shortcuts]: customization.md#shortcut-keys

‎docs/customization.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,10 @@ commitizen:
167167

168168
#### Shortcut keys
169169

170-
When the [`use_shortcuts`](https://commitizen-tools.github.io/commitizen/config/#settings) config option is enabled, commitizen can show and use keyboard shortcuts to select items from lists directly.
170+
When the [`use_shortcuts`](config.md#settings) config option is enabled, commitizen can show and use keyboard shortcuts to select items from lists directly.
171171
For example, when using the `cz_conventional_commits` commitizen template, shortcut keys are shown when selecting the commit type. Unless otherwise defined, keyboard shortcuts will be numbered automatically.
172172
To specify keyboard shortcuts for your custom choices, provide the shortcut using the `key` parameter in dictionary form for each choice you would like to customize.
173-
173+
174174
## 2. Customize through customizing a class
175175

176176
The basic steps are:

‎docs/faq.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ version_files = [
3030
## Why are `revert` and `chore` valid types in the check pattern of cz conventional_commits but not types we can select?
3131

3232
`revert` and `chore` are added to the "pattern" in `cz check` in order to prevent backward errors, but officially they are not part of conventional commits, we are using the latest [types from Angular](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) (they used to but were removed).
33-
However, you can create a customized `cz` with those extra types. (See [Customization](https://commitizen-tools.github.io/commitizen/customization/)
33+
However, you can create a customized `cz` with those extra types. (See [Customization](customization.md)
3434

3535
See more discussion in issue [#142](https://github.com/commitizen-tools/commitizen/issues/142) and [#36](https://github.com/commitizen-tools/commitizen/issues/36)
3636

‎docs/tutorials/gitlab_ci.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ _Goal_: Bump a new version every time that a change occurs on the `master` branc
1010
2. A developer creates a merge request (MR) against `master` branch
1111
3. When the `MR` is merged into master, the 2 stages of the CI are executed
1212
4. For simplification, we store the software version in a file called `VERSION`. You can use any file that you want as `commitizen` supports it.
13-
5. The commit message executed automatically by the `CI` must include `[skip-ci]` in the message; otherwise, the process will generate a loop. You can define the message structure in [commitizen](https://commitizen-tools.github.io/commitizen/bump/) as well.
13+
5. The commit message executed automatically by the `CI` must include `[skip-ci]` in the message; otherwise, the process will generate a loop. You can define the message structure in [commitizen](../bump.md) as well.
1414

1515
### Gitlab Configuration
1616

‎docs/tutorials/writing_commits.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@ understand what happened.
3838
| `fix(commands): bump error when no user provided` | `fix: stuff` |
3939
| `feat: add new commit command` | `feat: commit command introduced` |
4040

41-
[customization]: https://commitizen-tools.github.io/commitizen/customization/
41+
[customization]: customization.md
4242
[conventional_commits]: https://www.conventionalcommits.org

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /