Skip to content

Commit

Permalink
docs: fix URL to releases page (#225)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicorikken authored Aug 14, 2022
1 parent b92e612 commit 5d52c15
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/ignore.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
</p>

<div align="center">
<a href="{{config.repo_url}}releases">
<a href="{{config.repo_url}}/releases">
<img alt="GitHub latest release" src="https://img.shields.io/github/v/release/get-woke/woke?logo=github&sort=semver">
</a>
<a href="{{config.repo_url}}releases">
<a href="{{config.repo_url}}/releases">
<img alt="GitHub Downloads" src="https://img.shields.io/github/downloads/get-woke/woke/total">
</a>
<a href="{{config.repo_url}}blob/main/LICENSE">
<a href="{{config.repo_url}}/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/badge/license-MIT-blue.svg">
</a>
<a href="https://codecov.io/gh/get-woke/woke/branch/main">
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/snippets/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5d52c15

Please sign in to comment.