Skip to content

Commit f0755bd

Browse files
committed
docs: some link-scaping
1 parent 12585f9 commit f0755bd

File tree

12 files changed

+35
-9
lines changed

12 files changed

+35
-9
lines changed

@commitlint/cli/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ npm install --save-dev @commitlint/cli @commitlint/config-angular
99
echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint.config.js
1010
```
1111

12-
Consult [docs/cli](../../docs/cli) for comprehensive documentation.
12+
Consult [docs/cli](http://marionebl.github.io/commitlint/#/reference-cli) for comprehensive documentation.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# commitlint-config-angular
2+
3+
> Mirror of [@commitlint/config-angular](../config-angular)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# commitlint-config-lerna-scopes
2+
3+
> Mirror of [@commitlint/config-lerna-scopes](../config-lerna-scopes)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# commitlint-config-patternplate
2+
3+
> Mirror of [@commitlint/config-patternplate](../config-patternplate)

@commitlint/config-angular/readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
> Lint your commits, angular-style
22
33
# @commitlint/config-angular
4+
45
Shareable `commitlint` config enforcing the angular commit convention.
6+
Use with [@commitlint/cli](../cli) and [@commitlint/prompt-cli](../prompt-cli).
57

68
## Getting started
79

@@ -14,6 +16,8 @@ echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint
1416
### Problems
1517

1618
The following rules are considered problems for `@commitlint/config-angular` and will yield a non-zero exit code when not met.
19+
Consult [docs/rules](http://marionebl.github.io/commitlint/#/reference-rules) for a list of available rules.
20+
1721

1822
#### type-enum
1923
* **condition**: `type` is found in value

@commitlint/config-lerna-scopes/readme.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
33
# @commitlint/config-lerna-scopes
44
Shareable `commitlint` config enforcing lerna package names as scopes.
5+
Use with [@commitlint/cli](../cli) and [@commitlint/prompt-cli](../prompt-cli).
56

67
## Getting started
78
```sh
@@ -37,3 +38,5 @@ packages
3738
⧗ input: chore: do some general maintenance
3839
✔ found 0 problems, 0 warnings
3940
```
41+
42+
Consult [docs/rules](http://marionebl.github.io/commitlint/#/reference-rules) for a list of available rules.

@commitlint/config-patternplate/readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
33
# @commitlint/config-patternplate
44
Shareable `commitlint` config enforcing the patternplate commit convention.
5+
Use with [@commitlint/cli](../cli) and [@commitlint/prompt-cli](../prompt-cli).
56

67
## Getting started
78
```sh
@@ -10,7 +11,8 @@ echo "module.exports = {extends: ['@commitlint/config-patternplate']};" > .commi
1011
```
1112

1213
## Rules
13-
`@commitlint/config-patternplate` extends the [shareable angular config](../config-angular#rules). Additionally these rules apply:
14+
`@commitlint/config-patternplate` extends the [shareable angular config](../config-angular#rules).
15+
Additionally these rules apply:
1416

1517
### Problems
1618
The following rules are considered problems for `@commitlint/config-patterplate` and will yield a non-zero exit code when not met.
@@ -19,3 +21,5 @@ The following rules are considered problems for `@commitlint/config-patterplate`
1921
* **description**: `scope` is found in `value`
2022
* **rule**: `always`
2123
* **value**: determined based on pattern tree. `system` and all pattern ids present in `patterns` are allowed
24+
25+
Consult [docs/rules](http://marionebl.github.io/commitlint/#/reference-rules) for a list of available rules.

@commitlint/core/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
npm install --save-dev @commitlint/core
99
```
1010

11-
Consult [docs/api](../../docs/api) for comprehensive documentation.
11+
Consult [docs/api](http://marionebl.github.io/commitlint/#/reference-api) for comprehensive documentation.

@commitlint/prompt-cli/readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint
1313
git add .
1414
commit
1515
```
16+
17+
A full usage guide is available at [docs/prompt](http://marionebl.github.io/commitlint/#/guides-use-prompt).

@commitlint/prompt/readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
33
# @commitlint/prompt
44

5+
This is the library and commitizen adapter version of commitlint prompt.
6+
A ready-to-use cli version is available at [@commitlint/prompt-cli](../prompt-cli).
7+
Learn how to use it at [docs/prompt](http://marionebl.github.io/commitlint/#/guides-use-prompt).
8+
59
## Getting started
610

711
```bash

0 commit comments

Comments
 (0)