diff --git a/docs/ignore.md b/docs/ignore.md index 6d9fe7c4..bf5d6503 100644 --- a/docs/ignore.md +++ b/docs/ignore.md @@ -20,7 +20,7 @@ ignore_files: You may also specify a `.wokeignore` file at the root of the directory to add additional ignore files. This also follows the [gitignore](https://git-scm.com/docs/gitignore) convention. -See [.wokeignore.example]({{config.repo_url}}blob/main/.wokeignore.example) for a collection of common files and directories that may contain generated [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithms) and [GUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)s. Dependency directories are also shown in the example as the linter will parse dependency source code and possibly find errors. +See [.wokeignore.example]({{config.repo_url}}/blob/main/.wokeignore.example) for a collection of common files and directories that may contain generated [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithms) and [GUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)s. Dependency directories are also shown in the example as the linter will parse dependency source code and possibly find errors. ## In-line and next-line ignoring diff --git a/docs/index.md b/docs/index.md index fc708a56..03af7f96 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,13 +6,13 @@

- + GitHub latest release - + GitHub Downloads - + License diff --git a/docs/installation.md b/docs/installation.md index a4721c9c..22acf771 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,11 +2,11 @@ !!! tip There are multiple ways to install `woke`. If you're interested in any installation methods - that are not listed here, feel free to open an [issue]({{config.repo_url}}issues). + that are not listed here, feel free to open an [issue]({{config.repo_url}}/issues). ## Releases -Download the latest binary from [Releases]({{config.repo_url}}releases/latest) +Download the latest binary from [Releases]({{config.repo_url}}/releases/latest) ## macOS diff --git a/docs/rules.md b/docs/rules.md index 42f3cfdd..bd3c068b 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -22,7 +22,7 @@ rules: # categories: nil ``` -A set of default rules is provided in [`pkg/rule/default.yaml`]({{config.repo_url}}blob/main/pkg/rule/default.yaml). +A set of default rules is provided in [`pkg/rule/default.yaml`]({{config.repo_url}}/blob/main/pkg/rule/default.yaml). !!! tip If you copy these rules into your config file, be sure to put them under the `rules:` key. diff --git a/docs/snippets/about.md b/docs/snippets/about.md index 7f5bef29..fb7dcf55 100644 --- a/docs/snippets/about.md +++ b/docs/snippets/about.md @@ -2,15 +2,15 @@ - **Caitlin Elfring** - [caitlinelfring](https://github.com/caitlinelfring) -See also the list of [contributors]({{config.repo_url}}contributors) who participated in this project. +See also the list of [contributors]({{config.repo_url}}/contributors) who participated in this project. ## Contributing -Please read [CONTRIBUTING.md]({{config.repo_url}}blob/main/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. +Please read [CONTRIBUTING.md]({{config.repo_url}}/blob/main/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. ## License This application is licensed under the MIT License, you may obtain a copy of it -[here]({{config.repo_url}}blob/main/LICENSE). +[here]({{config.repo_url}}/blob/main/LICENSE). [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fget-woke%2Fwoke.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fget-woke%2Fwoke?ref=badge_large) diff --git a/docs/usage.md b/docs/usage.md index 93bf6dad..ce06bd6b 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -11,7 +11,7 @@ Configure your custom rules config in `.woke.yaml` or `.woke.yml`. `woke` uses t This file will be picked up automatically up your customizations without needing to supply it with the `-c` flag. -See [example.yaml]({{config.repo_url}}blob/main/example.yaml) for an example of adding custom rules. +See [example.yaml]({{config.repo_url}}/blob/main/example.yaml) for an example of adding custom rules. You can also supply your own rules with `-c path/to/rules.yaml` if you want to handle different rulesets. ### Remote config file