Docs theme updates (#23832)

qmk · May 31, 2024 · 119e54e · 119e54e
1 parent 32af90a
commit 119e54e
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 13 deletions.
diff --git a/builddefs/docsgen/.vitepress/theme/custom.css b/builddefs/docsgen/.vitepress/theme/custom.css
@@ -1,7 +1,19 @@
 /* Override <kbd> as vitepress doesn't put them with borders */
 kbd {
  border: 1px solid var(--vp-c-text-1);
- border-radius: 0.6em;
+ border-radius: 5px;
  margin: 0.2em;
  padding: 0.2em;
 }
+
+:root {
+ --vp-nav-logo-height: 32px;
+
+ --vp-layout-max-width: calc(98% + 64px);
+
+ --vp-sidebar-width: 300px;
+}
+
+.VPDoc.has-aside .content-container {
+ max-width: unset !important;
+}
diff --git a/docs/cli_development.md b/docs/cli_development.md
@@ -207,7 +207,7 @@ qmk format-python
 We use [yapf](https://github.com/google/yapf) to automatically format code. Our configuration is in the `[yapf]` section of `setup.cfg`.
 
 ::: tip
-Tip- Many editors can use yapf as a plugin to automatically format code as you type.
+Many editors can use yapf as a plugin to automatically format code as you type.
 :::
 
 ## Testing Details
@@ -217,7 +217,7 @@ Our tests can be found in `lib/python/qmk/tests/`. You will find both unit and i
 If your PR does not include a comprehensive set of tests please add comments like this to your code so that other people know where they can help:
 
 ```python
- # TODO(unassigned/<your_github_username>): Write <unit|integration> tests
+# TODO(unassigned/<your_github_username>): Write <unit|integration> tests
 ```
 
 We use [nose2](https://nose2.readthedocs.io/en/latest/getting_started.html) to run our tests. You can refer to the nose2 documentation for more details on what you can do in your test functions.

diff --git a/docs/driver_installation_zadig.md b/docs/driver_installation_zadig.md
@@ -65,7 +65,7 @@ Run `pnputil /delete-driver oemXX.inf /uninstall`. This will delete the driver a
 As with the previous section, this process may need to be repeated multiple times, as multiple drivers can be applicable to the same device.
 
 ::: warning
-**WARNING:** Be *extremely careful* when doing this! You could potentially uninstall the driver for some other critical device. If you are unsure, double check the output of `/enum-drivers`, and omit the `/uninstall` flag when running `/delete-driver`.
+Be *extremely careful* when doing this! You could potentially uninstall the driver for some other critical device. If you are unsure, double check the output of `/enum-drivers`, and omit the `/uninstall` flag when running `/delete-driver`.
 :::
 
 ## List of Known Bootloaders

diff --git a/docs/feature_sequencer.md b/docs/feature_sequencer.md
@@ -3,7 +3,7 @@
 Since QMK has experimental support for MIDI, you can now turn your keyboard into a [step sequencer](https://en.wikipedia.org/wiki/Music_sequencer#Step_sequencers)!
 
 ::: warning
-**IMPORTANT:** This feature is highly experimental, it has only been tested on a Planck EZ so far. Also, the scope will be limited to support the drum machine use-case to start with.
+This feature is highly experimental, it has only been tested on a Planck EZ so far. Also, the scope will be limited to support the drum machine use-case to start with.
 :::
 
 ## Enable the step sequencer

diff --git a/docs/isp_flashing_guide.md b/docs/isp_flashing_guide.md
@@ -286,7 +286,7 @@ avrdude done. Thank you.
 This is a slightly more advanced topic, but may be necessary if you are switching from one bootloader to another (for example, Caterina to Atmel/QMK DFU on a Pro Micro). Fuses control some of the low-level functionality of the AVR microcontroller, such as clock speed, whether JTAG is enabled, and the size of the section of flash memory reserved for the bootloader, among other things. You can find a fuse calculator for many AVR parts [here](https://www.engbedded.com/conffuse/).
 
 ::: warning
-**WARNING:** Setting incorrect fuse values, in particular the clock-related bits, may render the MCU practically unrecoverable without high voltage programming (not covered here)! Make sure to double check the commands you enter before you execute them.
+Setting incorrect fuse values, in particular the clock-related bits, may render the MCU practically unrecoverable without high voltage programming (not covered here)! Make sure to double check the commands you enter before you execute them.
 :::
 
 To set the fuses, add the following to the `avrdude` command:

diff --git a/docs/newbs.md b/docs/newbs.md
@@ -6,10 +6,9 @@ QMK tries to put a lot of power into your hands by making easy things easy, and
 
 Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a [large number of hobbyist boards](https://qmk.fm/keyboards/). If your current keyboard can't run QMK there are a lot of choices out there for boards that do.
 
-::: tip
-**Is This Guide For Me?**<br>
-:::
+::: tip Is This Guide For Me?
 If the thought of programming intimidates you, please [take a look at our online GUI](newbs_building_firmware_configurator) instead.
+:::
 
 ## Overview
 

diff --git a/docs/newbs_building_firmware_workflow.md b/docs/newbs_building_firmware_workflow.md
@@ -2,11 +2,9 @@
 
 This is an intermediate QMK tutorial to setup an out-of-tree build environment with a personal GitHub repository. It avoids using a fork of the QMK firmware to store and build your keymap within its source tree. Keymap files will instead be stored in your own personal GitHub repository, in [Userspace](feature_userspace) format, and built with an action workflow. Unlike the [default tutorial](newbs), this guide requires some familiarity with using Git.
 
-::: tip
-**Is This Guide For Me?**<br>
-:::
+::: tip Is This Guide For Me?
 This is a lean setup to avoid space-consuming local build environment in your computer. Troubleshooting compile-time errors will be slower with commit uploads to GitHub for the compiler workflow.
-
+:::
 
 ## Prerequisites