From b74cd39ab59e3f22016502e3515f25d7ca396901 Mon Sep 17 00:00:00 2001 From: Cem Aksoylar Date: Sat, 31 Aug 2024 21:36:51 -0700 Subject: [PATCH] chore(blog): Use truncate markers --- docs/blog/2020-05-24-wip.md | 2 ++ docs/blog/2020-08-12-zmk-sotf-1.md | 2 ++ docs/blog/2020-09-21-zmk-sotf-2.md | 2 ++ docs/blog/2020-10-03-bootloader-fix.md | 2 ++ docs/blog/2020-11-09-zmk-sotf-3.md | 2 ++ docs/blog/2021-01-27-zmk-sotf-4.md | 2 ++ docs/blog/2021-07-17-zephyr-2-5.md | 2 ++ docs/blog/2022-03-08-zephyr-3-0-upgrade-prep.md | 2 ++ docs/blog/2022-04-02-zephyr-3-0.md | 2 ++ docs/blog/2022-04-10-zmk-sotf-5.md | 2 ++ docs/blog/2022-04-21-zmk-2yo.md | 2 ++ docs/blog/2023-04-06-zephyr-3-2.md | 2 ++ docs/blog/2023-06-18-encoder-refactors.md | 2 ++ docs/blog/2023-10-05-zmk-sotf-6.md | 2 ++ docs/blog/2023-11-09-keymap-editor.mdx | 6 ++++-- docs/blog/2023-12-17-nodefree-config.md | 2 ++ docs/blog/2024-01-05-zmk-tools.md | 3 +++ docs/blog/2024-02-09-zephyr-3-5.md | 2 ++ docs/docusaurus.config.js | 1 + 19 files changed, 40 insertions(+), 2 deletions(-) mode change 100755 => 100644 docs/blog/2024-01-05-zmk-tools.md diff --git a/docs/blog/2020-05-24-wip.md b/docs/blog/2020-05-24-wip.md index 51dff434..e2d2e022 100644 --- a/docs/blog/2020-05-24-wip.md +++ b/docs/blog/2020-05-24-wip.md @@ -8,3 +8,5 @@ This blog is a work-in-progress as I work on basic docs + blog on this nascent k As is, there are more features _missing_ from ZMK than features it has. As always with pre-alpha software, if something breaks, you get to keep both halves! (especially if it is a split KB) + + diff --git a/docs/blog/2020-08-12-zmk-sotf-1.md b/docs/blog/2020-08-12-zmk-sotf-1.md index 62936b38..c93566b1 100644 --- a/docs/blog/2020-08-12-zmk-sotf-1.md +++ b/docs/blog/2020-08-12-zmk-sotf-1.md @@ -8,6 +8,8 @@ Welcome to the first ZMK "State Of The Firmware"! With interest and Discord activity growing, it seemed important to lay out the progress made recently, current major bugs/showstoppers, and planned next steps. + + ## Recent Activity There's been lots of various activity in ZMK land! diff --git a/docs/blog/2020-09-21-zmk-sotf-2.md b/docs/blog/2020-09-21-zmk-sotf-2.md index 4536d828..c65898f0 100644 --- a/docs/blog/2020-09-21-zmk-sotf-2.md +++ b/docs/blog/2020-09-21-zmk-sotf-2.md @@ -9,6 +9,8 @@ Welcome to the second ZMK "State Of The Firmware" (SOTF)! This update will cover all the major activity since [SOTF #1](/blog/2020/08/12/zmk-sotf-1), preparations for the upcoming Hacktoberfest activity, and a current open call for community feedback on a ZMK mascot. + + ## Recent Activity So much going on in ZMK! diff --git a/docs/blog/2020-10-03-bootloader-fix.md b/docs/blog/2020-10-03-bootloader-fix.md index 4c2f6063..41495fe5 100644 --- a/docs/blog/2020-10-03-bootloader-fix.md +++ b/docs/blog/2020-10-03-bootloader-fix.md @@ -9,6 +9,8 @@ Recently I was able to fix the "stuck in the bootloader" issue in for quite some time. I want to go over what the issue was, how the issue was diagnosed, and how it was fixed. + + ## Background What exactly is the "stuck in the bootloader" issue? Seemingly randomly, users' diff --git a/docs/blog/2020-11-09-zmk-sotf-3.md b/docs/blog/2020-11-09-zmk-sotf-3.md index f1f0f81d..428fe408 100644 --- a/docs/blog/2020-11-09-zmk-sotf-3.md +++ b/docs/blog/2020-11-09-zmk-sotf-3.md @@ -8,6 +8,8 @@ Welcome to the third ZMK "State Of The Firmware" (SOTF)! This update will cover all the major activity since [SOTF #2](/blog/2020/09/21/zmk-sotf-2). This edition comes a bit later than planned, but the amount of features and changes will hopefully make it worth it! + + ## Recent Activity Here's a summary of the various major changes since last time, broken down by theme: diff --git a/docs/blog/2021-01-27-zmk-sotf-4.md b/docs/blog/2021-01-27-zmk-sotf-4.md index f6e9f81d..f3105a4a 100644 --- a/docs/blog/2021-01-27-zmk-sotf-4.md +++ b/docs/blog/2021-01-27-zmk-sotf-4.md @@ -8,6 +8,8 @@ Welcome to the fourth ZMK "State Of The Firmware" (SOTF)! This update will cover all the major activity since [SOTF #3](/blog/2020/11/09/zmk-sotf-3). + + ## Recent Activity Here's a summary of the various major changes since last time, broken down by theme: diff --git a/docs/blog/2021-07-17-zephyr-2-5.md b/docs/blog/2021-07-17-zephyr-2-5.md index fbd12658..73087fb8 100644 --- a/docs/blog/2021-07-17-zephyr-2-5.md +++ b/docs/blog/2021-07-17-zephyr-2-5.md @@ -6,6 +6,8 @@ tags: [firmware, zephyr, core] I'm happy to announce that we have completed the [work](https://github.com/zmkfirmware/zmk/pull/736/) to upgrade ZMK to [Zephyr 2.5](https://docs.zephyrproject.org/2.5.0/releases/release-notes-2.5.html)! + + A big part of this work was some _major_ refactors and improvements by [innovaker] to our [zmk-docker](https://github.com/zmkfirmware/zmk-docker/) Docker image and GH Actions automation. - Faster build times with improved caching. diff --git a/docs/blog/2022-03-08-zephyr-3-0-upgrade-prep.md b/docs/blog/2022-03-08-zephyr-3-0-upgrade-prep.md index cbe3e2a0..6086991b 100644 --- a/docs/blog/2022-03-08-zephyr-3-0-upgrade-prep.md +++ b/docs/blog/2022-03-08-zephyr-3-0-upgrade-prep.md @@ -7,6 +7,8 @@ tags: [firmware, zephyr, core] As preparation for completing the [work](https://github.com/zmkfirmware/zmk/pull/1143) to upgrade ZMK to [Zephyr 3.0](https://docs.zephyrproject.org/3.0.0/releases/release-notes-3.0.html), users with user config repositories who wish to avoid future build failures with their GitHub Actions workflows can take steps to adjust their repositories now. + + GitHub Actions needs to use our latest Docker image to ensure continued compatibility with the ZMK codebase on Zephyr 3.0 (and beyond). You should: - Open `.github/workflows/build.yml` in your editor/IDE diff --git a/docs/blog/2022-04-02-zephyr-3-0.md b/docs/blog/2022-04-02-zephyr-3-0.md index 1756c437..193256a7 100644 --- a/docs/blog/2022-04-02-zephyr-3-0.md +++ b/docs/blog/2022-04-02-zephyr-3-0.md @@ -6,6 +6,8 @@ tags: [firmware, zephyr, core] I'm happy to announce that we have completed the [work](https://github.com/zmkfirmware/zmk/pull/1143) to upgrade ZMK to [Zephyr 3.0](https://docs.zephyrproject.org/3.0.0/releases/release-notes-3.0.html)! + + [petejohanson] did the upgrade work to adjust ZMK for the Zephyr changes. - Moving to Zephyr's UF2 build integration that was submitted upstream by [petejohanson] diff --git a/docs/blog/2022-04-10-zmk-sotf-5.md b/docs/blog/2022-04-10-zmk-sotf-5.md index 6ea9db11..f0f54a96 100644 --- a/docs/blog/2022-04-10-zmk-sotf-5.md +++ b/docs/blog/2022-04-10-zmk-sotf-5.md @@ -8,6 +8,8 @@ Welcome to the fifth ZMK "State Of The Firmware" (SOTF)! This update will cover all the major activity since [SOTF #4](/blog/2021/01/27/zmk-sotf-4). That was over a year ago, so lots to cover! + + ## Recent Activity Here's a summary of the various major changes since last time, broken down by theme: diff --git a/docs/blog/2022-04-21-zmk-2yo.md b/docs/blog/2022-04-21-zmk-2yo.md index f272ebe8..102e0748 100644 --- a/docs/blog/2022-04-21-zmk-2yo.md +++ b/docs/blog/2022-04-21-zmk-2yo.md @@ -6,6 +6,8 @@ tags: [keyboards, firmware, oss] Two years ago, today, I minted the first ever commit for ZMK: + + ``` commit 85c8be89dea8f7a00e8efb06d38e2b32f3459935 Author: Pete Johanson diff --git a/docs/blog/2023-04-06-zephyr-3-2.md b/docs/blog/2023-04-06-zephyr-3-2.md index 62336198..21d3816d 100644 --- a/docs/blog/2023-04-06-zephyr-3-2.md +++ b/docs/blog/2023-04-06-zephyr-3-2.md @@ -6,6 +6,8 @@ tags: [firmware, zephyr, core] I'm happy to announce that we have completed the [work](https://github.com/zmkfirmware/zmk/pull/1499) to upgrade ZMK to [Zephyr 3.2](https://docs.zephyrproject.org/3.2.0/releases/release-notes-3.2.html)! + + [petejohanson] did the upgrade work to adjust ZMK for the Zephyr changes, with help from [Nicell] on the LVGL pieces. - Upgrade to LVGL 8.x API, and move to the new Kconfig settings. diff --git a/docs/blog/2023-06-18-encoder-refactors.md b/docs/blog/2023-06-18-encoder-refactors.md index ed47eee9..8efaa57d 100644 --- a/docs/blog/2023-06-18-encoder-refactors.md +++ b/docs/blog/2023-06-18-encoder-refactors.md @@ -8,6 +8,8 @@ Today, we merged a significant change to the low level sensor code that is used this paves the way for completing the work on supporting split peripheral sensors/encoders, and other future sensors like pointing devices. + + As part of the work, backwards compatibility for existing shields has been retained, but only for a grace period to allow out-of-tree shields to move to the new approach for encoders. Special thanks to [joelspadin] for the _thorough_ code review and testing throughout the development of the refactor. diff --git a/docs/blog/2023-10-05-zmk-sotf-6.md b/docs/blog/2023-10-05-zmk-sotf-6.md index 4b72cf06..441c0233 100644 --- a/docs/blog/2023-10-05-zmk-sotf-6.md +++ b/docs/blog/2023-10-05-zmk-sotf-6.md @@ -8,6 +8,8 @@ Welcome to the sixth ZMK "State Of The Firmware" (SOTF)! This update will cover all the major activity since [SOTF #5](/blog/2022/04/10/zmk-sotf-5). That was over a year ago (again!), so there are many new exciting features and plenty of improvements to cover! + + ## Recent Activity Here's a summary of the various major changes since last time, broken down by theme: diff --git a/docs/blog/2023-11-09-keymap-editor.mdx b/docs/blog/2023-11-09-keymap-editor.mdx index d6ac9df0..a0c5332f 100644 --- a/docs/blog/2023-11-09-keymap-editor.mdx +++ b/docs/blog/2023-11-09-keymap-editor.mdx @@ -6,6 +6,10 @@ tags: [keyboards, firmware, community] import ThemedImage from "@theme/ThemedImage"; +This blog post is the first in a series of posts where we highlight projects within the ZMK ecosystem that we think are cool and that the users might benefit from knowing about them. We are starting the series with a big one, [Keymap Editor](http://nickcoutsos.github.io/keymap-editor) by [Nick Coutsos](https://github.com/nickcoutsos)! + +{/* truncate */} + -This blog post is the first in a series of posts where we highlight projects within the ZMK ecosystem that we think are cool and that the users might benefit from knowing about them. We are starting the series with a big one, [Keymap Editor] by [Nick Coutsos](https://github.com/nickcoutsos)! - In the rest of the post we leave it to Nick himself to introduce the project, detail his goals and motivation in developing such a tool, and talk about the future of the project. Stay tuned for future installments in the series! ## What is Keymap Editor? diff --git a/docs/blog/2023-12-17-nodefree-config.md b/docs/blog/2023-12-17-nodefree-config.md index 877f3e0e..d7fecdf4 100644 --- a/docs/blog/2023-12-17-nodefree-config.md +++ b/docs/blog/2023-12-17-nodefree-config.md @@ -14,6 +14,8 @@ by [urob](https://github.com/urob) that contains helper methods that utilizes th for users who prefer editing and maintaining their ZMK config directly using the Devicetree syntax format. + + In the rest of the post we leave it to urob to introduce and explain the motivations of the project, and various ways it can be used to help maintain ZMK keymaps. Stay tuned for future installments in the series! diff --git a/docs/blog/2024-01-05-zmk-tools.md b/docs/blog/2024-01-05-zmk-tools.md old mode 100755 new mode 100644 index 2879bd42..1104396d --- a/docs/blog/2024-01-05-zmk-tools.md +++ b/docs/blog/2024-01-05-zmk-tools.md @@ -9,6 +9,9 @@ that we think are interesting and that the users might benefit from knowing abou In this installment, we are highlighting two projects (and a bonus one!) from [Joel Spadin](https://github.com/joelspadin), a member of the core ZMK team. + + + The first one is [ZMK Tools](#zmk-tools), a handy Visual Studio Code extension to ease working with ZMK configurations, and the second is [ZMK Locale Generator](#zmk-locale-generator), a tool to help users that use non-US English keyboard locales in their operating systems. In the rest of the post we leave it to Joel to introduce and explain the motivations of his ZMK-related projects. diff --git a/docs/blog/2024-02-09-zephyr-3-5.md b/docs/blog/2024-02-09-zephyr-3-5.md index 1733dbe6..8b3c941a 100644 --- a/docs/blog/2024-02-09-zephyr-3-5.md +++ b/docs/blog/2024-02-09-zephyr-3-5.md @@ -6,6 +6,8 @@ tags: [firmware, zephyr, core] I'm happy to announce that we have completed the [work](https://github.com/zmkfirmware/zmk/pull/1995) to upgrade ZMK to [Zephyr 3.5](https://docs.zephyrproject.org/3.5.0/releases/release-notes-3.5.html)! + + [petejohanson] did the upgrade work to adjust ZMK for the Zephyr changes: - Add `west flash` support to all UF2 capable boards. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index ae26fd43..b4e3449a 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -165,6 +165,7 @@ module.exports = { ], ], markdown: { + format: "detect", mermaid: true, mdx1Compat: { comments: false,