摘要: Docusaurus v4安装指南
从新创建 简介 本文章基于v4版本 Docusaurus的基本单元分为 页面page 博客blog 文档doc 参考
https://haozi.moe/2022/02/04/hexo%E8%BF%81%E7%A7%BBDocusaurus/
https://github.com/haozi23333
官方方式创建 1 npx create-docusaurus@latest my-website classic
fork代码创建 启动开发服务器 1 2 3 4 npm run start 清理本地缓存 pnpm docusaurus clear
目录介绍 1 2 3 4 5 6 7 blog --博客目录 docs --文档目录 static --静态资源目录 src\pages --页面 docusaurus.config.ts --配置文件 src\pages\index.tsx 主页 src\components\HomepageFeatures --主页依赖组件
搜索 本地搜索插件https://github.com/cmfcmf/docusaurus-search-local
使用Swizzle自定义主题 教程https://docusaurus.io/zh-CN/docs/swizzling
以下是组件参考 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 以下是组件参考 admin@ZLAY-R15 MINGW64 /d/GitRepository/blog-docusaurus (main) $ npm run swizzle @docusaurus/theme-classic -- --list > [email protected] swizzle> docusaurus swizzle @docusaurus/theme-classic --list √ Which language do you want to use? » TypeScript [INFO] Components available for swizzle in @docusaurus/theme-classic: ┌──────────────────────────────────────────┬───────────┬───────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ │ Component name │ Wrap │ Eject │ Description │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Icon/Danger │ Safe │ Safe │ The admonition danger icon │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Icon/Info │ Safe │ Safe │ The admonition info icon │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Icon/Note │ Safe │ Safe │ The admonition note icon │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Icon/Tip │ Safe │ Safe │ The admonition tip icon │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Icon/Warning │ Safe │ Safe │ The admonition warning icon │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Layout │ Safe │ Safe │ The standard admonition layout applied to all default admonition types │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Type/Caution │ Safe │ Safe │ The component responsible for rendering a :::caution admonition type │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Type/Danger │ Safe │ Safe │ The component responsible for rendering a :::danger admonition type │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Type/Info │ Safe │ Safe │ The component responsible for rendering a :::info admonition type │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Type/Note │ Safe │ Safe │ The component responsible for rendering a :::note admonition type │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Type/Tip │ Safe │ Safe │ The component responsible for rendering a :::tip admonition type │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Type/Warning │ Safe │ Safe │ The component responsible for rendering a :::warning admonition type │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock │ Safe │ Safe │ The component used to render multi-line code blocks, generally used in Markdown files. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ColorModeToggle │ Safe │ Safe │ The color mode toggle to switch between light and dark mode. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocCardList │ Safe │ Safe │ The component responsible for rendering a list of sidebar items cards. │ │ │ │ │ Notable used on the category generated-index pages. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Footer │ Safe │ Safe │ The footer component of your site's layout │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Footer/Copyright │ Safe │ Safe │ The footer copyright │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Footer/Layout │ Safe │ Safe │ The footer main layout component │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Footer/LinkItem │ Safe │ Safe │ The footer link item component │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Footer/Links │ Safe │ Safe │ The footer component rendering the footer links │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Footer/Links/MultiColumn │ Safe │ Safe │ The footer component rendering the footer links with a multi-column layout │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Footer/Links/Simple │ Safe │ Safe │ The footer component rendering the footer links with a simple layout (single row) │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Footer/Logo │ Safe │ Safe │ The footer logo │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Arrow │ Safe │ Safe │ The arrow icon component │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/DarkMode │ Safe │ Safe │ The dark mode icon component. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Edit │ Safe │ Safe │ The edit icon component │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/LightMode │ Safe │ Safe │ The light mode icon component. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Menu │ Safe │ Safe │ The menu icon component │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents/A │ Safe │ Safe │ The component used to render <a> tags and Markdown links in MDX │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents/Code │ Safe │ Safe │ The component used to render <code> tags and Markdown code blocks in MDX │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents/Details │ Safe │ Safe │ The component used to render <details> tags in MDX │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents/Heading │ Safe │ Safe │ The component used to render heading tags (<h1>, <h2>...) and Markdown headings in MDX │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents/Img │ Safe │ Safe │ The component used to render <img> tags and Markdown images in MDX │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents/Pre │ Safe │ Safe │ The component used to render <pre> tags in MDX │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents/Ul │ Safe │ Safe │ The component used to render <ul> tags and Markdown unordered lists in MDX │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXContent │ Safe │ Safe │ A component wrapping all MDX content and providing the MDXComponents to the MDX context │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NotFound │ Safe │ Safe │ The global 404 page of your site, meant to be ejected and customized │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ SearchBar │ Safe │ Safe │ The search bar component of your site, appearing in the navbar. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ SkipToContent │ Safe │ Safe │ The component responsible for implementing the accessibility "skip to content" link (https://www.w3.org/TR/WCAG20-TECHS/G1.html) │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebar │ Safe │ Unsafe │ The sidebar component on docs pages │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Icon │ Forbidden │ Safe │ The folder containing all admonition icons │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Type │ Forbidden │ Safe │ The folder containing all the admonition type components. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition/Types │ Forbidden │ Safe │ The object mapping admonition type to a React component. │ │ │ │ │ Use it to add custom admonition type components, or replace existing ones. │ │ │ │ │ Can be ejected or wrapped (only manually, see our documentation). │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents │ Forbidden │ Safe │ The MDX components to use for rendering MDX files. Meant to be ejected. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/ComponentTypes │ Forbidden │ Safe │ The Navbar item components mapping. Can be ejected to add custom navbar item types. │ │ │ │ │ See https://github.com/facebook/docusaurus/issues/7227. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ prism-include-languages │ Forbidden │ Safe │ The Prism languages to include for code block syntax highlighting. Meant to be ejected. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Admonition │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ AnnouncementBar │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ AnnouncementBar/CloseButton │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ AnnouncementBar/Content │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BackToTopButton │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Blog │ Forbidden │ Forbidden │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Blog/Components │ Forbidden │ Forbidden │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Blog/Components/Author │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Blog/Components/Author/Socials │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Blog/Pages │ Forbidden │ Forbidden │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Blog/Pages/BlogAuthorsListPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Blog/Pages/BlogAuthorsPostsPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogArchivePage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogLayout │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogListPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogListPage/StructuredData │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogListPaginator │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem/Container │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem/Content │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem/Footer │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem/Footer/ReadMoreLink │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem/Header │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem/Header/Authors │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem/Header/Info │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItem/Header/Title │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostItems │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostPage/Metadata │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostPage/StructuredData │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogPostPaginator │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogSidebar │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogSidebar/Content │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogSidebar/Desktop │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogSidebar/Mobile │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogTagsListPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ BlogTagsPostsPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Buttons │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Buttons/Button │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Buttons/CopyButton │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Buttons/WordWrapButton │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Container │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Content │ Unsafe │ Unsafe │ The folder containing components responsible for rendering different types of CodeBlock content. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Content/Element │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Content/String │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Layout │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Line │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Line/Token │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeBlock/Title │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ CodeInline │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ContentVisibility │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ContentVisibility/Draft │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ContentVisibility/Unlisted │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Details │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocBreadcrumbs │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocBreadcrumbs/Items │ Forbidden │ Unsafe │ The components responsible for rendering the breadcrumb items │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocBreadcrumbs/Items/Home │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocBreadcrumbs/StructuredData │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocCard │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocCategoryGeneratedIndexPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem/Content │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem/Footer │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem/Layout │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem/Metadata │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem/Paginator │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem/TOC │ Forbidden │ Forbidden │ The DocItem TOC is not directly swizzle-able, but you can swizzle its sub-components. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem/TOC/Desktop │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocItem/TOC/Mobile │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocPaginator │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocRoot │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocRoot/Layout │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocRoot/Layout/Main │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocRoot/Layout/Sidebar │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocRoot/Layout/Sidebar/ExpandButton │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebar/Desktop │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebar/Desktop/CollapseButton │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebar/Desktop/Content │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebar/Mobile │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebarItem/Category │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebarItem/Html │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebarItem/Link │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocSidebarItems │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocTagDocListPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocTagsListPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocVersionBadge │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocVersionBanner │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocVersionRoot │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ DocsRoot │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ EditMetaRow │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ EditThisPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ErrorPageContent │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Heading │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon │ Forbidden │ Forbidden │ The Icon folder is not directly swizzle-able, but you can swizzle its sub-components. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Close │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Copy │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/ExternalLink │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Home │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Language │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials │ Forbidden │ Forbidden │ The Icon/Socials folder is not directly swizzle-able, but you can swizzle its sub-components. │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/Bluesky │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/Default │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/GitHub │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/Instagram │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/LinkedIn │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/Mastodon │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/StackOverflow │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/Threads │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/Twitch │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/Twitter │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/X │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Socials/YouTube │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/Success │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/SystemColorMode │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Icon/WordWrap │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ LastUpdated │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Layout │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Layout/Provider │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Logo │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXComponents/Li │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ MDXPage │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Mermaid │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/ColorModeToggle │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/Content │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/Layout │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/Logo │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/MobileSidebar │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/MobileSidebar/Header │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/MobileSidebar/Layout │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/MobileSidebar/PrimaryMenu │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/MobileSidebar/SecondaryMenu │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/MobileSidebar/Toggle │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Navbar/Search │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DefaultNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DefaultNavbarItem/Desktop │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DefaultNavbarItem/Mobile │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DocNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DocSidebarNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DocsVersionDropdownNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DocsVersionNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DropdownNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DropdownNavbarItem/Desktop │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/DropdownNavbarItem/Mobile │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/HtmlNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/LocaleDropdownNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/NavbarNavLink │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NavbarItem/SearchNavbarItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ NotFound/Content │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ PaginatorNavLink │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ SearchMetadata │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ SiteMetadata │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TOC │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TOCCollapsible │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TOCCollapsible/CollapseButton │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TOCInline │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TOCItems │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TOCItems/Tree │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TabItem │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Tabs │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Tag │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TagsListByLetter │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ TagsListInline │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ThemeProvider │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ThemeProvider/TitleFormatter │ Unsafe │ Unsafe │ N/A │ ├──────────────────────────────────────────┼───────────┼───────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ThemedImage │ Unsafe │ Unsafe │ N/A │ └──────────────────────────────────────────┴───────────┴───────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ Swizzle actions: ┌─────────┬────────────┬──────────────────────────────────────────────────────────────────────────────────┐ │ Actions │ CLI option │ Description │ ├─────────┼────────────┼──────────────────────────────────────────────────────────────────────────────────┤ │ Wrap │ `--wrap` │ │ │ │ │ Creates a wrapper around the original theme component. │ │ │ │ Allows rendering other components before/after the original theme component. │ │ │ │ │ │ │ │ Tip: prefer `--wrap` whenever possible to reduce the amount of code to maintain. │ │ │ │ │ ├─────────┼────────────┼──────────────────────────────────────────────────────────────────────────────────┤ │ Eject │ `--eject` │ │ │ │ │ Ejects the full source code of the original theme component. │ │ │ │ Allows overriding of the original component entirely with your own UI and logic. │ │ │ │ │ │ │ │ Tip: `--eject` can be useful for completely redesigning a component. │ │ │ │ │ └─────────┴────────────┴──────────────────────────────────────────────────────────────────────────────────┘ Swizzle safety statuses: ┌───────────┬────────────┬─────────────────────────────────────────────────────────────────────────────┐ │ Status │ CLI option │ Description │ ├───────────┼────────────┼─────────────────────────────────────────────────────────────────────────────┤ │ Safe │ │ │ │ │ │ This component is safe to swizzle and was designed for this purpose. │ │ │ │ The swizzled component is retro-compatible with minor version upgrades. │ │ │ │ │ ├───────────┼────────────┼─────────────────────────────────────────────────────────────────────────────┤ │ Unsafe │ `--danger` │ │ │ │ │ This component is unsafe to swizzle, but you can still do it! │ │ │ │ Warning: we may release breaking changes within minor version upgrades. │ │ │ │ You will have to upgrade your component manually and maintain it over time. │ │ │ │ │ │ │ │ Tip: your customization can't be done in a Safe way? │ │ │ │ Report it here: https://github.com/facebook/docusaurus/discussions/5468 │ │ │ │ │ ├───────────┼────────────┼─────────────────────────────────────────────────────────────────────────────┤ │ Forbidden │ │ │ │ │ │ This component is not meant to be swizzled. │ │ │ │ │ └───────────┴────────────┴─────────────────────────────────────────────────────────────────────────────┘ Swizzle guide: https://docusaurus.io/docs/swizzling admin@ZLAY-R15 MINGW64 /d/GitRepository/blog-docusaurus (main) $
修改教程 1 2 3 4 5 6 使用以下命令 将代码下载下来 BlogListPage为组件名称 npm run swizzle @docusaurus/theme-classic BlogListPage 或者 npm run swizzle @docusaurus/theme-classic Navbar/Content 之后根据需求修改测试 之后删除不需要的代码即可
调试页面 1 http://127.0.0.1:3000/__docusaurus/debug
使用kuizuo模版 下载代码 模版地址https://github.com/kuizuo/blog
1 2 3 4 5 6 7 8 9 10 11 12 13 # 安装pnpm npm install -g pnpm # 配置 sharp 优先使用预编译包 npm install sharp pnpm config set sharp_binary_host "https://npmmirror.com/mirrors/sharp" pnpm config set sharp_libvips_binary_host "https://npmmirror.com/mirrors/sharp-libvips" # 安装 pnpm install # 本地 启动 pnpm start # 构建 pnpm build # 测试build的页面 npm run serve
目录 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 ├── blog # 博客 │ ├── first-blog.md ├── docs # 文档/笔记 │ └── doc.md ├── data │ ├── feature.tsx # 特点 │ ├── friends.tsx # 友链 │ ├── projects.tsx # 项目 │ ├── skills.tsx # 技术栈 │ └── social.ts # 社交链接 ├── i18n # 国际化 ├── src │ ├── components # 组件 │ ├── css # 自定义CSS │ ├── pages # 自定义页面 │ ├── plugin # 自定义插件 │ └── theme # 自定义主题组件 ├── static # 静态资源文件 │ └── img # 静态图片 ├── docusaurus.config.ts # 站点的配置信息 ├── sidebars.ts # 文档的侧边栏 ├── package.json ├── tsconfig.json └── pnpm-lock.yaml
部署Vercel 构建命令
输出目录