跳到主要内容

Docusaurus Tips 记录

博客文章​

  • 控制博客文章在博客列表中展示出来的内容预览
<!--truncate-->

只会在博客列表中展示上方的内容, 隐藏其下方的内容

MDX​

示例
<button onClick={() => alert("button clicked!")}>Click me!</button>

图片引用​

  • 存放在项目根目录 static 文件夹中 img 文件夹里的图片可以直接引用 /img/xxx.jpg
  • 存放在博客文件夹中 img 文件夹里的图片可以使用相对路径 ./img/xxx.jpg

代码块​

/path/to/file
添加 title="xxx" 可以设置文件路径

提示​

自定义显示文字

tip/danger 分别对应绿色提示和红色警告, 紧跟着使用 [] 可以自定义显示文字

专题教程​

  • 在 docs 文件夹下创建一个文件夹, 如果需要放图片, 就在里面创建 img 文件夹, 例如:
docs/tutorial-basics/img
  • 在该专题文件夹下创建一个文件, 其中存放专题相关的信息
_category_.json

文件内容示例:

{
  "label": "Tutorial - Basics",
  "position": 2,
  "link": {
    "type": "generated-index",
    "description": "5 minutes to learn the most important Docusaurus concepts."
  }
}

搜索​

  • 等到内容发布上线之后, 再去 申请 API

其他​