如何在Docusaurus的MDX文档中导入JSON文件至代码块展示?
在Docusaurus中直接引用本地JSON文件生成代码块
我正在使用Docusaurus构建文档,该框架采用MDX语法。我希望无需复制粘贴文件内容,直接在文档中通过代码块展示本地JSON文件的内容。
当前手动实现方式
目前我需要在MD文档中手动编写以下内容:
查看 `helloworld.json` 文件的内容: ```json title="helloworld.json" { "hello": "world" }
## 期望的实现方式 我希望通过项目中的 `asserts/helloworld.json` 文件,采用类似下面的写法来实现(无需手动复制文件内容): ```md 查看 `helloworld.json` 文件的内容: ```json title="helloworld.json" from "asserts/helloworld.json"
## 实现方案 Docusaurus的MDX语法支持直接导入本地文件,结合JSON序列化可以实现需求,具体步骤如下: 1. 在MDX文档中导入目标JSON文件 使用`@site`别名指向项目根目录,导入`asserts/helloworld.json`文件: ```mdx import helloworld from '@site/asserts/helloworld.json';
- 在代码块中展示文件内容
利用JSON.stringify()格式化JSON内容,插入到代码块中:
查看 `helloworld.json` 文件的内容: ```json title="helloworld.json" {JSON.stringify(helloworld, null, 2)}
这种方式会自动读取本地JSON文件的内容并格式化展示,后续修改JSON文件时,文档中的代码块内容会同步更新,无需手动复制粘贴。 内容的提问来源于stack exchange,提问作者Maxime Charrière
相关产品推荐
相关产品推荐

