You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在Markdown文件中加载并展示同仓库内JSON文件的指定内容

同仓库JSON内容动态展示到README的解决方案

纯静态Markdown本身不支持直接读取并加载同一仓库内的文件内容,所以无法直接实现你描述的类似load调用的写法,以下是可落地的替代方案:

  • 方案1:CI/CD自动同步内容
    你可以写个简单的本地/流水线脚本,自动提取JSON对应片段更新到README中,无需手动复制粘贴,示例Python脚本如下:

    import json
    import re
    
    # 读取目标JSON文件
    with open("random_file.json", "r", encoding="utf-8") as f:
        json_data = json.load(f)
    
    # 提取需要展示的片段并格式化
    show_part = json.dumps(json_data["other_stuff"], indent=4, ensure_ascii=False)
    formatted_content = f'"other_stuff": {show_part}'
    
    # 替换README中的对应占位内容
    with open("README.md", "r", encoding="utf-8") as f:
        readme_content = f.read()
    
    # 你需要提前在README对应位置写好占位标记
    updated_readme = re.sub(
        r"<!-- JSON_PART_OTHER_STUFF_START -->(.*?)<!-- JSON_PART_OTHER_STUFF_END -->",
        f"<!-- JSON_PART_OTHER_STUFF_START -->\n```json\n{formatted_content}\n```\n<!-- JSON_PART_OTHER_STUFF_END -->",
        readme_content,
        flags=re.DOTALL
    )
    
    with open("README.md", "w", encoding="utf-8") as f:
        f.write(updated_readme)
    

    你可以把这个脚本配置到GitHub Actions、GitLab CI等仓库流水线中,设置为random_file.json修改时自动执行并提交更新后的README,全程无需人工操作。

  • 方案2:直接链接JSON文件
    如果不需要把内容直接展示在README正文中,你可以直接用相对路径链接跳转查看完整JSON:
    [查看完整random_file.json](./random_file.json)
    托管在GitHub/GitLab等平台的仓库,点击该链接会直接展示格式化后的JSON内容。

  • 方案3:自定义静态站点渲染逻辑
    如果你是用VuePress、Docusaurus等静态站点生成器渲染文档,可以自定义Markdown组件,直接读取本地JSON文件的指定字段渲染到页面中,完全实现你理想中的调用效果。

内容的提问来源于stack exchange,提问作者user3470496

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.09.27 10:54:01