Skip to content

Commit

Permalink
style: Formatting docs
Browse files Browse the repository at this point in the history
Signed-off-by: AlexNg <[email protected]>
  • Loading branch information
caffeine-addictt committed Jan 19, 2025
1 parent 5aec50d commit aee81f5
Show file tree
Hide file tree
Showing 7 changed files with 251 additions and 256 deletions.
5 changes: 0 additions & 5 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
template/CITATION.cff
dist/*


www/
!www/mkdocs.yml
!www/docs/static/schema.json

template/
!template/template.json

Expand Down
4 changes: 2 additions & 2 deletions www/docs/configuration/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Here is a quick overview of how to get started with Waku templates.
For demonstration purposes,
let's create a new template containing 1 style called `My Style`.

1. Create the style directory
1. Create the style directory

Create a new subdirectory called `my-style`.
The files you create in this directory
will be copied and formatted over when `waku new` is ran.

1. Create a waku `config` file
1. Create a waku `config` file

=== "Yaml"

Expand Down
10 changes: 5 additions & 5 deletions www/docs/configuration/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
You can use them in your styles by having `{{{ .Key }}}`
in your files.

| Key | Description |
| --- | ------------------------------------------------ |
| `.Name` | the project name |
| `.License` | the project license text (i.e. MIT License) |
| `.Spdx` | the project license SPDX identifier (i.e. MIT) |
| Key | Description |
| ---------- | ---------------------------------------------- |
| `.Name` | the project name |
| `.License` | the project license text (i.e. MIT License) |
| `.Spdx` | the project license SPDX identifier (i.e. MIT) |
2 changes: 1 addition & 1 deletion www/docs/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ please update your code accordingly.
This flag was deprecated in favor of the `--source` flag which works
like `--repo` but it also accepts local directory paths. Switching
to `--source` is __NOT BREAKING__.
to `--source` is **NOT BREAKING**.

## Removed in v0

Expand Down
14 changes: 7 additions & 7 deletions www/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ Requires Go `1.23+`.

All artifacts are checksummed, and the checksum file is signed with [cosign][].

1. Download the files you want, and the `checksums.txt`, `checksums.txt.pem`
and `checksums.txt.sig` files from the [releases][] page.
1. Download the files you want, and the `checksums.txt`, `checksums.txt.pem`
and `checksums.txt.sig` files from the [releases][] page.

```sh
curl -O 'https://github.com/caffeine-addictt/waku/releases/download/v0.8.0/checksums.txt'
```
```sh
curl -O 'https://github.com/caffeine-addictt/waku/releases/download/v0.8.0/checksums.txt'
```

1. Verify checksums signature:
1. Verify checksums signature:

```bash
cosign verify-blob \
Expand All @@ -105,7 +105,7 @@ and `checksums.txt.sig` files from the [releases][] page.
./checksums.txt
```

1. Verify the SHA256 checksums:
1. Verify the SHA256 checksums:

```bash
sha256sum --ignore-missing -c checksums.txt
Expand Down
Loading

0 comments on commit aee81f5

Please sign in to comment.