在Dumi项目中实现Markdown文本的变量替换功能
2025-06-19 10:13:25作者:段琳惟
在文档系统开发过程中,经常会遇到需要根据不同环境或产品版本动态替换文档内容的需求。本文将介绍如何在Dumi项目中实现Markdown文件的变量替换功能。
需求背景
在开发OEM产品或多版本文档时,文档中的图片、文字和URL等元素往往需要根据不同产品线或客户需求进行定制化替换。传统做法是维护多份文档副本,但这会导致维护成本增加和版本管理困难。
技术实现方案
方案一:Remark插件
Dumi基于Remark处理Markdown文件,因此可以通过自定义Remark插件实现变量替换:
- 创建一个自定义Remark插件
- 在插件中使用正则表达式匹配需要替换的文本模式
- 从环境变量或配置文件中读取替换值
- 执行全局替换操作
这种方案的优点是灵活性高,可以精确控制替换逻辑和范围。
方案二:构建时预处理
另一种思路是在构建流程中加入预处理步骤:
- 在构建前扫描所有Markdown文件
- 识别特殊标记(如
{{VARIABLE_NAME}}) - 用环境变量或配置文件中的值替换这些标记
- 将处理后的文件交给Dumi正常构建
实际应用建议
虽然Dumi原生不直接支持此功能,但通过插件系统可以优雅地实现。对于已经采用Docusaurus的项目,可以参考其变量替换的实现方式。
注意事项
- 替换操作应在构建早期阶段进行
- 考虑缓存处理结果以提高构建性能
- 设计清晰的变量命名规范
- 提供详细的替换日志便于调试
通过合理设计变量替换系统,可以显著提高多版本文档的维护效率,同时保持代码库的整洁性。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0153- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
LongCat-Video-Avatar-1.5最新开源LongCat-Video-Avatar 1.5 版本,这是一款经过升级的开源框架,专注于音频驱动人物视频生成的极致实证优化与生产级就绪能力。该版本在 LongCat-Video 基础模型之上构建,可生成高度稳定的商用级虚拟人视频,支持音频-文本转视频(AT2V)、音频-文本-图像转视频(ATI2V)以及视频续播等原生任务,并能无缝兼容单流与多流音频输入。00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0112
项目优选
收起
暂无描述
Dockerfile
733
4.75 K
deepin linux kernel
C
31
16
Ascend Extension for PyTorch
Python
651
797
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.25 K
153
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.1 K
611
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.01 K
1.01 K
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
147
237
昇腾LLM分布式训练框架
Python
168
200
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
434
395
暂无简介
Dart
986
253