From 6d8bb2414aaee861e92581d8f53bb47dee94712b Mon Sep 17 00:00:00 2001 From: zvecr Date: Thu, 30 May 2024 04:55:56 +0100 Subject: [PATCH 1/4] Update docs theming --- builddefs/docsgen/.vitepress/theme/custom.css | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/builddefs/docsgen/.vitepress/theme/custom.css b/builddefs/docsgen/.vitepress/theme/custom.css index 77726adedebf..ece9d18bfd44 100644 --- a/builddefs/docsgen/.vitepress/theme/custom.css +++ b/builddefs/docsgen/.vitepress/theme/custom.css @@ -1,7 +1,17 @@ /* Override 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(100% + 64px); +} + +.VPDoc.has-aside .content-container { + max-width: unset !important; +} From 855672cbfa1ae8ea98a73cb467822448dd639f06 Mon Sep 17 00:00:00 2001 From: zvecr Date: Thu, 30 May 2024 05:04:40 +0100 Subject: [PATCH 2/4] Temp fix for sidebar --- builddefs/docsgen/.vitepress/theme/custom.css | 2 ++ 1 file changed, 2 insertions(+) diff --git a/builddefs/docsgen/.vitepress/theme/custom.css b/builddefs/docsgen/.vitepress/theme/custom.css index ece9d18bfd44..843fded91126 100644 --- a/builddefs/docsgen/.vitepress/theme/custom.css +++ b/builddefs/docsgen/.vitepress/theme/custom.css @@ -10,6 +10,8 @@ kbd { --vp-nav-logo-height: 32px; --vp-layout-max-width: calc(100% + 64px); + + --vp-sidebar-width: 300px; } .VPDoc.has-aside .content-container { From 3ec04ca4a83c54ea4d8be6b85e0f4fd1d83d2171 Mon Sep 17 00:00:00 2001 From: zvecr Date: Thu, 30 May 2024 11:05:34 +0100 Subject: [PATCH 3/4] Misc container fixes --- docs/cli_development.md | 4 ++-- docs/driver_installation_zadig.md | 2 +- docs/feature_sequencer.md | 2 +- docs/isp_flashing_guide.md | 2 +- docs/newbs.md | 5 ++--- docs/newbs_building_firmware_workflow.md | 6 ++---- 6 files changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/cli_development.md b/docs/cli_development.md index 159bca4faa88..2e74220d4be4 100644 --- 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/): Write tests +# TODO(unassigned/): Write 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 index 69113863f8f7..ce16ada166ac 100644 --- 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 index c58b6225cac2..f5f1f549afd8 100644 --- 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 index afebcc6ad651..6f3f0a8f7d08 100644 --- 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 index 10d043c3eda3..64593cbad12c 100644 --- 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?**
-::: +::: 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 index 01c2e69032b4..a5123892783e 100644 --- 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?**
-::: +::: 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 From ef66c1cd6860d4b3b6d072d934a9228fdd7ed8fe Mon Sep 17 00:00:00 2001 From: zvecr Date: Fri, 31 May 2024 01:21:39 +0100 Subject: [PATCH 4/4] Firefox improvements --- builddefs/docsgen/.vitepress/theme/custom.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/builddefs/docsgen/.vitepress/theme/custom.css b/builddefs/docsgen/.vitepress/theme/custom.css index 843fded91126..732cb5b74fec 100644 --- a/builddefs/docsgen/.vitepress/theme/custom.css +++ b/builddefs/docsgen/.vitepress/theme/custom.css @@ -9,7 +9,7 @@ kbd { :root { --vp-nav-logo-height: 32px; - --vp-layout-max-width: calc(100% + 64px); + --vp-layout-max-width: calc(98% + 64px); --vp-sidebar-width: 300px; }