diff --git a/@commitlint/cli/README.md b/@commitlint/cli/README.md index 427a399c09..75f3b0fa4c 100644 --- a/@commitlint/cli/README.md +++ b/@commitlint/cli/README.md @@ -1,7 +1,7 @@ > Lint commit messages

- +

# @commitlint/cli @@ -13,4 +13,4 @@ npm install --save-dev @commitlint/cli @commitlint/config-angular echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js ``` -Consult [docs/cli](https://conventional-changelog.github.io/#/reference-cli) for comprehensive documentation. +Consult [docs/cli](https://conventional-changelog.github.io/commitlint/#/reference-cli) for comprehensive documentation. diff --git a/@commitlint/config-angular/README.md b/@commitlint/config-angular/README.md index 3359eb2d55..62ae7f98ae 100644 --- a/@commitlint/config-angular/README.md +++ b/@commitlint/config-angular/README.md @@ -20,7 +20,7 @@ echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint. ### Problems The following rules are considered problems for `@commitlint/config-angular` and will yield a non-zero exit code when not met. -Consult [docs/rules](https://conventional-changelog.github.io/#/reference-rules) for a list of available rules. +Consult [docs/rules](https://conventional-changelog.github.io/commitlint/#/reference-rules) for a list of available rules. #### type-enum diff --git a/@commitlint/config-conventional/README.md b/@commitlint/config-conventional/README.md index a25809668c..2ea5a669b4 100644 --- a/@commitlint/config-conventional/README.md +++ b/@commitlint/config-conventional/README.md @@ -21,7 +21,7 @@ echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commit The following rules are considered problems for `@commitlint/config-conventional` and will yield a non-zero exit code when not met. -Consult [docs/rules](https://conventional-changelog.github.io/#/reference-rules) for a list of available rules. +Consult [docs/rules](https://conventional-changelog.github.io/commitlint/#/reference-rules) for a list of available rules. #### type-enum diff --git a/@commitlint/config-lerna-scopes/readme.md b/@commitlint/config-lerna-scopes/readme.md index c1d4cc40de..c06db1343f 100644 --- a/@commitlint/config-lerna-scopes/readme.md +++ b/@commitlint/config-lerna-scopes/readme.md @@ -40,4 +40,4 @@ packages ✔ found 0 problems, 0 warnings ``` -Consult [docs/rules](https://conventional-changelog.github.io/#/reference-rules) for a list of available rules. +Consult [docs/rules](https://conventional-changelog.github.io/commitlint/#/reference-rules) for a list of available rules. diff --git a/@commitlint/config-patternplate/README.md b/@commitlint/config-patternplate/README.md index 9205b34549..cccc35be42 100644 --- a/@commitlint/config-patternplate/README.md +++ b/@commitlint/config-patternplate/README.md @@ -22,4 +22,4 @@ The following rules are considered problems for `@commitlint/config-patterplate` * **rule**: `always` * **value**: determined based on pattern tree. `system` and all pattern ids present in `patterns` are allowed -Consult [docs/rules](https://conventional-changelog.github.io/#/reference-rules) for a list of available rules. +Consult [docs/rules](https://conventional-changelog.github.io/commitlint/#/reference-rules) for a list of available rules. diff --git a/@commitlint/format/README.md b/@commitlint/format/README.md index a711938a35..bc1a398d9b 100644 --- a/@commitlint/format/README.md +++ b/@commitlint/format/README.md @@ -59,5 +59,5 @@ process.stdout.write(output); ] */ ``` -Consult [docs/api](https://conventional-changelog.github.io/#/reference-api) for comprehensive documentation. +Consult [docs/api](https://conventional-changelog.github.io/commitlint/#/reference-api) for comprehensive documentation. diff --git a/@commitlint/lint/README.md b/@commitlint/lint/README.md index 33674846e3..66095d2d9a 100644 --- a/@commitlint/lint/README.md +++ b/@commitlint/lint/README.md @@ -30,4 +30,4 @@ lint('foo: bar', {'type-enum': [1, 'always', ['bar']]}) */ ``` -Consult [docs/api](https://conventional-changelog.github.io/#/reference-api) for comprehensive documentation. +Consult [docs/api](https://conventional-changelog.github.io/commitlint/#/reference-api) for comprehensive documentation. diff --git a/@commitlint/load/README.md b/@commitlint/load/README.md index 301a1af6db..b163d937a7 100644 --- a/@commitlint/load/README.md +++ b/@commitlint/load/README.md @@ -18,4 +18,4 @@ load({extends: ['./package']}) // => { extends: ['./package', './package-b'], rules: {} } ``` -Consult [docs/api](https://conventional-changelog.github.io/#/reference-api) for comprehensive documentation. +Consult [docs/api](https://conventional-changelog.github.io/commitlint/#/reference-api) for comprehensive documentation. diff --git a/@commitlint/prompt-cli/README.md b/@commitlint/prompt-cli/README.md index ff1295050c..82273bc612 100644 --- a/@commitlint/prompt-cli/README.md +++ b/@commitlint/prompt-cli/README.md @@ -14,4 +14,4 @@ git add . commit ``` -A full usage guide is available at [docs/prompt](https://conventional-changelog.github.io/#/guides-use-prompt). +A full usage guide is available at [docs/prompt](https://conventional-changelog.github.io/commitlint/#/guides-use-prompt). diff --git a/@commitlint/prompt/README.md b/@commitlint/prompt/README.md index 8059b43fec..55f18044e1 100644 --- a/@commitlint/prompt/README.md +++ b/@commitlint/prompt/README.md @@ -4,7 +4,7 @@ This is the library and commitizen adapter version of commitlint prompt. A ready-to-use cli version is available at [@commitlint/prompt-cli](../prompt-cli). -Learn how to use it at [docs/prompt](https://conventional-changelog.github.io/#/guides-use-prompt). +Learn how to use it at [docs/prompt](https://conventional-changelog.github.io/commitlint/#/guides-use-prompt). ## Getting started diff --git a/@commitlint/read/README.md b/@commitlint/read/README.md index a194f9e478..4b0c993aa8 100644 --- a/@commitlint/read/README.md +++ b/@commitlint/read/README.md @@ -24,4 +24,4 @@ read({from: 'HEAD~2', to: 'HEAD~1'}) // => ['Initial commit\n\n'] ``` -Consult [docs/api](https://conventional-changelog.github.io/#/reference-api) for comprehensive documentation. +Consult [docs/api](https://conventional-changelog.github.io/commitlint/#/reference-api) for comprehensive documentation. diff --git a/README.md b/README.md index 8daed2ef5b..4759c6f88c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# [Get Started](https://conventional-changelog.github.io/#/?id=getting-started) | [Let's chat][12] ![slack][11] | [Website](https://conventional-changelog.github.io) +# [Get Started](https://conventional-changelog.github.io/commitlint/#/?id=getting-started) | [Let's chat][12] ![slack][11] | [Website](https://conventional-changelog.github.io/commitlint) > Lint commit messages @@ -101,8 +101,8 @@ To lint commits before they are created you can use Husky's 'commit-msg' hook: **Detailed Setup instructions** -* [Local setup](https://conventional-changelog.github.io/#/guides-local-setup) - Lint messages on commit with husky -* [CI setup](https://conventional-changelog.github.io/#/guides-ci-setup) - Lint messages during CI builds +* [Local setup](https://conventional-changelog.github.io/commitlint/#/guides-local-setup) - Lint messages on commit with husky +* [CI setup](https://conventional-changelog.github.io/commitlint/#/guides-ci-setup) - Lint messages during CI builds ## CLI