From 2dc54b36a7e889ed1da9b2cec00c02521dc6e6b4 Mon Sep 17 00:00:00 2001 From: Isaac Donaldson <46387819+isaacdonaldson@users.noreply.github.com> Date: Sat, 9 Nov 2024 01:05:22 -0800 Subject: [PATCH] A series of small improvements to the docs and the docs site (#974) * change -k section to be accurate with new scaffolding options * add bacon command since cargo watch suggests to use it * fix links and code sections in the blog with dark mode enabled * adjust the width of the page to always provide some padding and simplify it a bit --- .../content/docs/getting-started/tour/index.md | 6 +++--- docs-site/content/docs/resources/faq.md | 6 ++++++ docs-site/static/styles/styles.css | 17 ++++++----------- docs-site/templates/docs/page.html | 2 +- docs-site/templates/macros/header.html | 2 +- 5 files changed, 17 insertions(+), 16 deletions(-) diff --git a/docs-site/content/docs/getting-started/tour/index.md b/docs-site/content/docs/getting-started/tour/index.md index 32cfc2066..d99c4d46f 100644 --- a/docs-site/content/docs/getting-started/tour/index.md +++ b/docs-site/content/docs/getting-started/tour/index.md @@ -94,7 +94,7 @@ We have a base SaaS app with user authentication generated for us. Let's make it
-You can choose between generating an `api`, `html` or `htmx` scaffold using the required `-k` flag. +You can choose between generating an `api`, `html` or `htmx` scaffold using the respective `-api`, `--html`, and `--htmx` flags.
```sh @@ -142,9 +142,9 @@ listening on port 5150
-Depending on which `-k` option you chose, the steps for creating a scaffolded resource will change. With the `api` flag or the `htmx` flag you can use the below example. But with the `html` flag, it is recommended you do the post creation steps in your browser. +Depending on which scaffold template option you chose (`-api`, `--html`, `--htmx`), the steps for creating a scaffolded resource will change. With the `--api` flag or the `--htmx` flag you can use the below example. But with the `--html` flag, it is recommended you do the post creation steps in your browser. -If you want to use `curl` to test the `html` scaffold, you will need to send your requests with the Content-Type `application/x-www-form-urlencoded` and the body as `title=Your+Title&content=Your+Content` by default. This can be changed to allow `application/json` as a `Content-Type` in the code if desired. +If you want to use `curl` to test the `--html` scaffold, you will need to send your requests with the Content-Type `application/x-www-form-urlencoded` and the body as `title=Your+Title&content=Your+Content` by default. This can be changed to allow `application/json` as a `Content-Type` in the code if desired.
diff --git a/docs-site/content/docs/resources/faq.md b/docs-site/content/docs/resources/faq.md index 77d501050..db711e7b9 100644 --- a/docs-site/content/docs/resources/faq.md +++ b/docs-site/content/docs/resources/faq.md @@ -23,6 +23,12 @@ Try [cargo watch](https://crates.io/crates/cargo-watch): $ cargo-watch -x check -s 'cargo loco start' ``` +Or [bacon](https://github.com/Canop/bacon) + +``` +$ bacon run +``` +
diff --git a/docs-site/static/styles/styles.css b/docs-site/static/styles/styles.css index af3fb8291..de70c72ae 100644 --- a/docs-site/static/styles/styles.css +++ b/docs-site/static/styles/styles.css @@ -618,33 +618,28 @@ a.active { @media (min-width: 640px) { .container { - max-width: 640px; + max-width: calc(640px - 1rem); } } @media (min-width: 768px) { .container { - max-width: 768px; + max-width: calc(768px - 2rem); } } @media (min-width: 1024px) { .container { - max-width: 1024px; + max-width: calc(1024px - 6rem); } } @media (min-width: 1280px) { .container { - max-width: 1280px; + max-width: calc(1280px - 8rem); } } -@media (min-width: 1536px) { - .container { - max-width: 1536px; - } -} .prose { color: var(--tw-prose-body); @@ -1005,7 +1000,7 @@ a.active { --tw-prose-body: var(--foreground); --tw-prose-headings: var(--foreground); --tw-prose-lead: #4b5563; - --tw-prose-links: #111827; + --tw-prose-links: var(--foreground); --tw-prose-bold: #111827; --tw-prose-counters: #6b7280; --tw-prose-bullets: #d1d5db; @@ -1015,7 +1010,7 @@ a.active { --tw-prose-captions: #6b7280; --tw-prose-kbd: #111827; --tw-prose-kbd-shadows: 17 24 39; - --tw-prose-code: #111827; + --tw-prose-code: var(--foreground); --tw-prose-pre-code: #e5e7eb; --tw-prose-pre-bg: #1f2937; --tw-prose-th-borders: #d1d5db; diff --git a/docs-site/templates/docs/page.html b/docs-site/templates/docs/page.html index 36b2b7cf7..5ed3d06bd 100644 --- a/docs-site/templates/docs/page.html +++ b/docs-site/templates/docs/page.html @@ -13,7 +13,7 @@ {% block content %}
-
+
diff --git a/docs-site/templates/macros/header.html b/docs-site/templates/macros/header.html index 1fd3fa392..4ea1be403 100644 --- a/docs-site/templates/macros/header.html +++ b/docs-site/templates/macros/header.html @@ -1,7 +1,7 @@ {% macro header(current_section) %}
-
+