Docusaurus 的默认侧边栏目录更改!插入图片或文字
通过以下步骤可轻松导入和使用 Docusaurus 主题组件。首先,在控制台中运行npm run swizzle命令,选择“@tarslib/docusaurus-theme”并导入所需组件,如 TOCItems (Unsafe)。通过浏览器控制台检查元素来快速定位组件。选择 Wrap (Unsafe)并确认,生成新组件后需重启项目。此后,您可以在组件中添加自定义内容。
Docusaurus 的默认侧边栏目录更改简单明了。首先,在控制台中通过npm run swizzle
命令选择主题,并导入所需组件。通过选择合适的组件,如 TOCItems (Unsafe),可以在 Docusaurus 文档中的右侧目录下方添加自定义内容。在此过程中,通过浏览器控制台检查元素来快速定位组件。一旦选择并确认 Wrap (Unsafe),项目需重启。随后,便能轻松在生成的组件中添加个性化内容。
步骤 1:导入组件
在控制台填写安装命令,然后 Enter 回车。
npm run swizzle
选择“@tarslib/docusaurus-theme”,然后回车进入下一步。
点击键盘的上下箭头可选择导入的组件,我们的目的是给 Docusaurus 文档中的右侧目录下方加一点内容(图片或文字),所以我这里选择导入TOCItems (Unsafe)
组件,如果你是要更改左侧目录,一般选择DocSidebarItems
组件,具体选择什么你可以点击这里查看有哪些组件,官方说是有 100 多个,你可以根据简短描述,找到正确组件,过程会有些曲折,慢慢试!
有一种方法可以帮助快速定位,打开浏览器的控制台来检查元素,上面有元素的 class 类,你可以根据里面的类名来快速定位到需要导入哪个组件。
接上一步,选择Wrap (Unsafe)
,然后回车。Wrap
主题的组件会创建一个原始主题组件的包装层,你可以在原有的基础上添加内容到组件里。另一个 Eject
就是把组件完全的拷贝出来了,不推荐使用!
最后选择YES: I know what I am doing!
,回车确定即可!
步骤 2:使用组件
最后会给你生成一个组件!到这一步之后,记得将项目重启,不然新组件会识别不出来。
项目重启后,你就可以在组件里添加内容了!
总结
通过以下步骤可轻松导入和使用 Docusaurus 主题组件。首先,在控制台中运行npm run swizzle
命令,选择“@tarslib/docusaurus-theme”并导入所需组件,如 TOCItems (Unsafe)。通过浏览器控制台检查元素来快速定位组件。选择 Wrap (Unsafe)并确认,生成新组件后需重启项目。此后,您可以在组件中添加自定义内容。
知识扩展: