From aee81f557b8379ec7a958e76d53342fa1c975425 Mon Sep 17 00:00:00 2001 From: AlexNg Date: Sun, 19 Jan 2025 21:50:47 +0800 Subject: [PATCH] style: Formatting docs Signed-off-by: AlexNg --- .prettierignore | 5 - www/docs/configuration/quick-start.md | 4 +- www/docs/configuration/templates.md | 10 +- www/docs/deprecations.md | 2 +- www/docs/install.md | 14 +- www/docs/overrides/home.html | 423 +++++++++++++------------- www/docs/overrides/main.html | 49 ++- 7 files changed, 251 insertions(+), 256 deletions(-) diff --git a/.prettierignore b/.prettierignore index 2d87fc2..203ca74 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,11 +2,6 @@ template/CITATION.cff dist/* - -www/ -!www/mkdocs.yml -!www/docs/static/schema.json - template/ !template/template.json diff --git a/www/docs/configuration/quick-start.md b/www/docs/configuration/quick-start.md index d8f3b83..3b86789 100644 --- a/www/docs/configuration/quick-start.md +++ b/www/docs/configuration/quick-start.md @@ -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" diff --git a/www/docs/configuration/templates.md b/www/docs/configuration/templates.md index 9ba83f8..c8fc556 100644 --- a/www/docs/configuration/templates.md +++ b/www/docs/configuration/templates.md @@ -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) | diff --git a/www/docs/deprecations.md b/www/docs/deprecations.md index 6b06965..ce60871 100644 --- a/www/docs/deprecations.md +++ b/www/docs/deprecations.md @@ -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 diff --git a/www/docs/install.md b/www/docs/install.md index 3da449d..baa1b52 100644 --- a/www/docs/install.md +++ b/www/docs/install.md @@ -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 \ @@ -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 diff --git a/www/docs/overrides/home.html b/www/docs/overrides/home.html index dfd5378..30b8e6f 100644 --- a/www/docs/overrides/home.html +++ b/www/docs/overrides/home.html @@ -1,228 +1,235 @@ -{% extends 'main.html' %} - -{% block tabs %} - {{ super() }} - - - -
- Waku logo - -

- Let's make starting new projects feel like a breeze again. -

- - Get Started -
- -
-

Focus on what matters most

-

- Waku is an open-source CLI tool that empowers developers - to quickly bring their ideas from conception to production. -

- -
-
-
-
- {% include ".icons/material/devices.svg" %} -
-

Cross-Platform

+ @media (min-width: 639px) { + .feature:nth-child(odd) { + width: 35%; + padding-left: 2.5rem; + } + } + + +
+ Waku logo + +

+ Let's make starting new projects feel like a + breeze again. +

+ + Get Started +
+ +
+

Focus on what matters most

+

+ Waku is an open-source CLI tool that empowers developers to quickly bring + their ideas from conception to production. +

+ +
+
+
+
+ {% include ".icons/material/devices.svg" %}
- -

Waku works on Linux, Windows, and macOS.

+

Cross-Platform

-
-
-
- {% include ".icons/material/devices.svg" %} -
-

Minimal Setup

-
- -

Waku makes the setup process quick and effortless, allowing you to dive right into coding without unnecessary delays.

-
+

Waku works on Linux, Windows, and macOS.

+
-
-
-
- {% include ".icons/simple/buildkite.svg" %} -
-

Easily Extensible

+
+
+
+ {% include ".icons/material/devices.svg" %}
- -

Waku supports community styles that are easy to create and use.

+

Minimal Setup

-
-
-
- {% include ".icons/octicons/repo-template-24.svg" %} -
-

Strong Templating Capabilities

-
+

+ Waku makes the setup process quick and effortless, allowing you to dive + right into coding without unnecessary delays. +

+
-

Waku leverages Go's powerful text/template library for templating.

+
+
+
+ {% include ".icons/simple/buildkite.svg" %} +
+

Easily Extensible

+ +

Waku supports community styles that are easy to create and use.

-
-
-

Ready to get started?

- waku waku! -
-{% endblock %} +
+
+
+ {% include ".icons/octicons/repo-template-24.svg" %} +
+

Strong Templating Capabilities

+
-{% block content %} -{% endblock %} +

+ Waku leverages Go's powerful text/template library for + templating. +

+
+
+
+ +
+

Ready to get started?

+ waku waku! +
+{% endblock %} {% block content %} {% endblock %} diff --git a/www/docs/overrides/main.html b/www/docs/overrides/main.html index 81755d5..cf4f398 100644 --- a/www/docs/overrides/main.html +++ b/www/docs/overrides/main.html @@ -1,32 +1,25 @@ -{% extends 'base.html' %} +{% extends 'base.html' %} {% block extrahead %} {% set title = config.site_name +%} {% if page and page.title and not page.is_homepage %} {% set title = +config.site_name ~ " - " ~ page.title | striptags %} {% endif %} {% set image = +config.site_url ~ '/static/logo-full.png' %} -{% block extrahead %} - {% set title = config.site_name %} - - {% if page and page.title and not page.is_homepage %} - {% set title = config.site_name ~ " - " ~ page.title | striptags %} - {% endif %} - - {% set image = config.site_url ~ '/static/logo-full.png' %} - - - - - - - - - - - - - + + + + + + + + + + + + {% endblock %} -{% block announce %} - We're committed to making Waku better! ❤️ -
- If you'd like to contribute, you can - sponsor me. -{% endblock %} +{% block announce %} We're committed to making Waku better! ❤️ +
+If you'd like to contribute, you can +sponsor me. {% endblock %}