chore(docs): update docs toolchain and format by liyang8246 · Pull Request #878 · HaoboGu/rmk

liyang8246 · 2026-06-09T06:19:40Z

更新了 favicon.ico 之前的必应好像识别不了
增加了 llm插件
清理 public/images, 各版本的图片应放在各版本分支自身的 docs/main/images 里
使用 rsbuild/tailwind 插件替代 postcss
更新依赖
格式化

…remove v3 configs

- Replace .prettierrc.json with prettier.config.ts using exported Config - Convert fetch-docs.js to fetch-docs.ts, run via tsx in postinstall - Add tsx as devDependency - Format .prettierignore (dist -> dist/)

github-actions · 2026-06-09T06:28:53Z

Size Report

Example	main	PR	Diff	.text
`use_config/nrf52832_ble`	372.1 KiB	372.1 KiB	+0.00% ⬆️	+12
`use_config/nrf52840_ble`	421.7 KiB	421.7 KiB	+0.00% ⬆️	+12
`use_config/nrf52840_ble_split (central)`	497.2 KiB	497.2 KiB	+0.00% ⬇️	-4
`use_config/nrf52840_ble_split (peripheral)`	322.2 KiB	322.2 KiB	+0.00% ⬇️	-4
`use_config/pi_pico_w_ble`	659.3 KiB	659.3 KiB	+0.00% ⬇️	-8
`use_config/rp2040`	147.2 KiB	147.2 KiB	+0.00% ⬆️	+4
`use_config/rp2040_split (central)`	160.5 KiB	160.4 KiB	+0.00% ⬇️	-8
`use_config/rp2040_split (peripheral)`	27.4 KiB	27.4 KiB	+0.00%	0
`use_config/stm32f1`	62.6 KiB	62.6 KiB	+0.00%	0
`use_config/stm32h7`	99.8 KiB	99.8 KiB	+0.00% ⬇️	-4
`use_rust/nrf52832_ble`	359.6 KiB	359.6 KiB	+0.00% ⬆️	+12
`use_rust/nrf52840_ble`	417.8 KiB	417.8 KiB	+0.00% ⬆️	+12
`use_rust/nrf52840_ble_split (central)`	506.6 KiB	506.6 KiB	+0.00%	0
`use_rust/nrf52840_ble_split (peripheral)`	319.0 KiB	319.0 KiB	+0.00%	0
`use_rust/pi_pico_w_ble`	659.8 KiB	659.9 KiB	+0.00% ⬆️	+32
`use_rust/rp2040`	147.2 KiB	147.2 KiB	+0.00% ⬆️	+4
`use_rust/rp2040_split (central)`	159.6 KiB	159.6 KiB	+0.00%	0
`use_rust/rp2040_split (peripheral)`	27.8 KiB	27.8 KiB	+0.00%	0
`use_rust/stm32f1`	62.6 KiB	62.6 KiB	-0.01% ⬇️	-8
`use_rust/stm32h7`	121.2 KiB	121.2 KiB	+0.00% ⬆️	+4

use_config/nrf52832_ble — 372.1 KiB → 372.1 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 341428	   5256	  34376	 381060	  5d084	rmk-nrf52832

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 341416	   5256	  34376	 381048	  5d078	rmk-nrf52832

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +32  [ = ]       0    .debug_ranges
  +0.0%     +32  [ = ]       0    .symtab
  +0.0%     +25  [ = ]       0    .strtab
  +0.0%     +20  [ = ]       0    .debug_frame
  +0.0%     +12  +0.0%     +12    .text
  +0.0%      +8  [ = ]       0    .debug_aranges
 -15.6%     -10  [ = ]       0    [Unmapped]
  -0.5%     -40  [ = ]       0    .debug_abbrev
  -0.1%    -188  [ = ]       0    .debug_line
  -0.0%    -234  [ = ]       0    .debug_str
  -0.2% -1.02Ki  [ = ]       0    .debug_loc
  -0.1% -1.72Ki  [ = ]       0    .debug_info
  -0.0% -3.08Ki  +0.0%     +12    TOTAL

use_config/nrf52840_ble — 421.7 KiB → 421.7 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 375412	   5264	  51176	 431852	  696ec	rmk-nrf52840

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 375400	   5264	  51176	 431840	  696e0	rmk-nrf52840

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0% +1.13Ki  [ = ]       0    .debug_str
  +0.0%     +64  [ = ]       0    .symtab
  +0.0%     +50  [ = ]       0    .strtab
  +0.1%     +36  [ = ]       0    .debug_frame
  +0.0%     +32  [ = ]       0    .debug_ranges
  +0.0%     +16  [ = ]       0    .debug_aranges
  +0.0%     +12  +0.0%     +12    .text
 -19.6%     -11  [ = ]       0    [Unmapped]
  -1.3%    -107  [ = ]       0    .debug_abbrev
  -0.1%    -286  [ = ]       0    .debug_line
  -0.1% -1.03Ki  [ = ]       0    .debug_loc
  -0.1% -2.41Ki  [ = ]       0    .debug_info
  -0.0% -2.50Ki  +0.0%     +12    TOTAL

use_config/nrf52840_ble_split (central) — 497.2 KiB → 497.2 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 455564	   6588	  46992	 509144	  7c4d8	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 455568	   6588	  46992	 509148	  7c4dc	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +9  [ = ]       0    .debug_line
  +4.3%      +3  [ = ]       0    [Unmapped]
  -0.0%      -2  [ = ]       0    .debug_abbrev
  -0.0%      -4  -0.0%      -4    .text
  -0.0%     -32  [ = ]       0    .debug_loc
  -0.0%   -1004  [ = ]       0    .debug_info
  -0.1% -2.44Ki  [ = ]       0    .debug_str
  -0.0% -3.45Ki  -0.0%      -4    TOTAL

use_config/nrf52840_ble_split (peripheral) — 322.2 KiB → 322.2 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 296548	   5920	  27512	 329980	  508fc	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 296552	   5920	  27512	 329984	  50900	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
 +10.0%      +4  [ = ]       0    [Unmapped]
  -0.0%      -4  -0.0%      -4    .text
  -0.0%     -23  [ = ]       0    .debug_str
  -0.0%    -397  [ = ]       0    .debug_info
  -0.0%    -420  -0.0%      -4    TOTAL

use_config/pi_pico_w_ble — 659.3 KiB → 659.3 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 619524	      0	  55572	 675096	  a4d18	rmk-pi-pico-w

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 619532	      0	  55572	 675104	  a4d20	rmk-pi-pico-w

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +2  [ = ]       0    .debug_loc
  -0.0%      -8  -0.0%      -8    .text
 -34.3%     -24  [ = ]       0    [Unmapped]
  -0.0%     -26  [ = ]       0    .debug_line
  -0.0%     -53  [ = ]       0    .debug_str
  -0.0%    -167  [ = ]       0    .debug_info
  -0.0%    -276  -0.0%      -8    TOTAL

use_config/rp2040 — 147.2 KiB → 147.2 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 135336	      0	  15372	 150708	  24cb4	rmk-rp2040

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 135332	      0	  15372	 150704	  24cb0	rmk-rp2040

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +85  [ = ]       0    .debug_str
  +0.0%      +4  +0.0%      +4    .text
  -0.0%      -3  [ = ]       0    .debug_line
 -13.6%      -6  [ = ]       0    [Unmapped]
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%    -202  [ = ]       0    .debug_info
  -0.0%    -132  +0.0%      +4    TOTAL

use_config/rp2040_split (central) — 160.5 KiB → 160.4 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 148116	      0	  16184	 164300	  281cc	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 148124	      0	  16184	 164308	  281d4	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +302  [ = ]       0    .debug_str
  +0.0%     +17  [ = ]       0    .debug_info
   +19%     +10  [ = ]       0    [Unmapped]
  -0.0%      -1  [ = ]       0    .debug_line
  -0.0%      -8  -0.0%      -8    .text
  -0.0%     -44  [ = ]       0    .debug_loc
  +0.0%    +276  -0.0%      -8    TOTAL

use_config/rp2040_split (peripheral) — 27.4 KiB → 27.4 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  25252	     60	   2764	  28076	   6dac	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  25252	     60	   2764	  28076	   6dac	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  -0.0%      -1  [ = ]       0    .strtab
  -0.0%      -3  [ = ]       0    .debug_str
  -0.0%      -4  [ = ]       0    TOTAL

use_config/stm32f1 — 62.6 KiB → 62.6 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  56596	     28	   7504	  64128	   fa80	rmk-stm32f1

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  56596	     28	   7504	  64128	   fa80	rmk-stm32f1

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +6  [ = ]       0    .debug_line
  +0.0%      +2  [ = ]       0    .strtab
 -10.4%      -7  [ = ]       0    [Unmapped]
  -0.0%    -309  [ = ]       0    .debug_str
  -0.0%    -308  [ = ]       0    TOTAL

use_config/stm32h7 — 99.8 KiB → 99.8 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  92140	    268	   9736	 102144	  18f00	rmk-stm32h7

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  92144	    268	   9736	 102148	  18f04	rmk-stm32h7

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +212  [ = ]       0    .debug_info
  +0.0%     +20  [ = ]       0    .debug_line
  +0.0%      +1  [ = ]       0    .strtab
  +1.8%      +1  [ = ]       0    [Unmapped]
  -0.0%      -4  -0.0%      -4    .text
  -0.0%    -534  [ = ]       0    .debug_str
  -0.0%    -304  -0.0%      -4    TOTAL

use_rust/nrf52832_ble — 359.6 KiB → 359.6 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 329560	   5264	  33368	 368192	  59e40	rmk-nrf52832

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 329548	   5264	  33368	 368180	  59e34	rmk-nrf52832

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +32  [ = ]       0    .symtab
  +0.0%     +25  [ = ]       0    .strtab
  +0.0%     +20  [ = ]       0    .debug_frame
  +0.0%     +16  [ = ]       0    .debug_ranges
  +0.0%     +12  +0.0%     +12    .text
  +0.0%      +8  [ = ]       0    .debug_aranges
 -26.4%     -14  [ = ]       0    [Unmapped]
  -0.1%    -242  [ = ]       0    .debug_line
  -0.2% -1.06Ki  [ = ]       0    .debug_loc
  -0.1% -1.52Ki  [ = ]       0    .debug_str
  -0.1% -2.68Ki  [ = ]       0    .debug_info
  -0.1% -5.41Ki  +0.0%     +12    TOTAL

use_rust/nrf52840_ble — 417.8 KiB → 417.8 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 375896	   5264	  46656	 427816	  68728	rmk-nrf52840

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 375884	   5264	  46656	 427804	  6871c	rmk-nrf52840

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +999  [ = ]       0    .debug_str
  +0.0%     +32  [ = ]       0    .debug_ranges
  +0.0%     +32  [ = ]       0    .symtab
  +0.0%     +24  [ = ]       0    .strtab
  +0.0%     +20  [ = ]       0    .debug_frame
  +0.0%     +12  +0.0%     +12    .text
  +0.0%      +8  [ = ]       0    .debug_aranges
 -20.8%     -11  [ = ]       0    [Unmapped]
  -0.1%    -236  [ = ]       0    .debug_line
  -0.1% -1.02Ki  [ = ]       0    .debug_loc
  -0.1% -2.15Ki  [ = ]       0    .debug_info
  -0.0% -2.31Ki  +0.0%     +12    TOTAL

use_rust/nrf52840_ble_split (central) — 506.6 KiB → 506.6 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 459444	   6588	  52728	 518760	  7ea68	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 459444	   6588	  52728	 518760	  7ea68	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +119  [ = ]       0    .debug_line
  +1.6%      +1  [ = ]       0    [Unmapped]
  -0.0%     -42  [ = ]       0    .debug_loc
  -0.0%    -502  [ = ]       0    .debug_info
  -0.1% -2.42Ki  [ = ]       0    .debug_str
  -0.0% -2.83Ki  [ = ]       0    TOTAL

use_rust/nrf52840_ble_split (peripheral) — 319.0 KiB → 319.0 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 294992	   5360	  26272	 326624	  4fbe0	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 294992	   5360	  26272	 326624	  4fbe0	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +375  [ = ]       0    .debug_info
  +0.0%    +286  [ = ]       0    .debug_str
  +0.0%     +22  [ = ]       0    .debug_loc
  +0.0%      +1  [ = ]       0    .debug_line
  -7.8%      -4  [ = ]       0    [Unmapped]
  +0.0%    +680  [ = ]       0    TOTAL

use_rust/pi_pico_w_ble — 659.8 KiB → 659.9 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 619972	      0	  55716	 675688	  a4f68	rmk-pi-pico-w

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 619940	      0	  55716	 675656	  a4f48	rmk-pi-pico-w

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1%    +866  [ = ]       0    .debug_loc
  +0.0%    +708  [ = ]       0    .debug_info
  +0.0%    +353  [ = ]       0    .debug_str
  +0.0%    +104  [ = ]       0    .debug_ranges
  +0.0%     +51  [ = ]       0    .debug_line
  +0.0%     +32  +0.0%     +32    .text
  -4.3%      -2  [ = ]       0    [Unmapped]
  +0.0% +2.06Ki  +0.0%     +32    TOTAL

use_rust/rp2040 — 147.2 KiB → 147.2 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 135520	      0	  15252	 150772	  24cf4	rmk-rp2040

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 135516	      0	  15252	 150768	  24cf0	rmk-rp2040

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +48  [ = ]       0    .debug_str
  +0.0%     +32  [ = ]       0    .debug_line
  +0.0%      +4  +0.0%      +4    .text
  -7.8%      -4  [ = ]       0    [Unmapped]
  +0.0%     +80  +0.0%      +4    TOTAL

use_rust/rp2040_split (central) — 159.6 KiB → 159.6 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 147484	      0	  15964	 163448	  27e78	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 147484	      0	  15964	 163448	  27e78	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  -2.0%      -1  [ = ]       0    [Unmapped]
  -0.0%     -38  [ = ]       0    .debug_line
  -0.0%    -275  [ = ]       0    .debug_info
  -0.0%    -346  [ = ]       0    .debug_str
  -0.0%    -660  [ = ]       0    TOTAL

use_rust/rp2040_split (peripheral) — 27.8 KiB → 27.8 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  25372	     60	   3028	  28460	   6f2c	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  25372	     60	   3028	  28460	   6f2c	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  -0.0%      -1  [ = ]       0    .strtab
  -5.2%      -3  [ = ]       0    [Unmapped]
  -0.0%      -4  [ = ]       0    .debug_str
  -0.0%      -8  [ = ]       0    TOTAL

use_rust/stm32f1 — 62.6 KiB → 62.6 KiB (-0.01% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  56636	     28	   7480	  64144	   fa90	rmk-stm32f1

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  56644	     28	   7480	  64152	   fa98	rmk-stm32f1

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +66  [ = ]       0    .debug_str
  +0.0%     +13  [ = ]       0    .debug_line
   +15%      +7  [ = ]       0    [Unmapped]
  -0.0%      -8  -0.0%      -8    .text
  -0.0%     -30  [ = ]       0    .debug_info
  +0.0%     +48  -0.0%      -8    TOTAL

use_rust/stm32h7 — 121.2 KiB → 121.2 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 108260	    324	  15524	 124108	  1e4cc	rmk-stm32h7

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 108256	    324	  15524	 124104	  1e4c8	rmk-stm32h7

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1%    +168  [ = ]       0    .debug_line
  +0.0%    +110  [ = ]       0    .debug_str
  +0.0%      +4  +0.0%      +4    .text
  -9.8%      -4  [ = ]       0    [Unmapped]
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%    -132  [ = ]       0    .debug_info
  +0.0%    +136  +0.0%      +4    TOTAL

HaoboGu · 2026-06-09T06:38:42Z

sweet!

liyang8246 added 7 commits June 9, 2026 10:41

docs: replace logo favicon with proper rounded favicon.ico

1c779e6

cleanup: delete orphan images, rename rmk_logo.svg -> logo.svg

950cd95

chore(deps): update all dependencies

6a5efe4

chore: switch to @rsbuild/plugin-tailwindcss, add dark mode variant, …

8c80108

…remove v3 configs

docs: migrate prettier config and fetch-docs to TypeScript (ESM)

5f27988

- Replace .prettierrc.json with prettier.config.ts using exported Config - Convert fetch-docs.js to fetch-docs.ts, run via tsx in postinstall - Add tsx as devDependency - Format .prettierignore (dist -> dist/)

style: prettier fmt

f60a39c

feat: add rspress/pluginLlms

b8ff68a

HaoboGu merged commit 79e012f into main Jun 9, 2026
46 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(docs): update docs toolchain and format#878

chore(docs): update docs toolchain and format#878
HaoboGu merged 7 commits into
mainfrom
chore/docs-tooling-upgrade

liyang8246 commented Jun 9, 2026

Uh oh!

github-actions Bot commented Jun 9, 2026

Uh oh!

HaoboGu commented Jun 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

liyang8246 commented Jun 9, 2026

Uh oh!

github-actions Bot commented Jun 9, 2026

Size Report

Uh oh!

HaoboGu commented Jun 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants