在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 StartedRust099- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiMo-V2.5-ProMiMo-V2.5-Pro作为旗舰模型,擅⻓处理复杂Agent任务,单次任务可完成近千次⼯具调⽤与⼗余轮上 下⽂压缩。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
项目优选
收起
deepin linux kernel
C
28
16
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
576
99
暂无描述
Dockerfile
710
4.51 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
958
955
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.61 K
942
Ascend Extension for PyTorch
Python
573
694
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
414
339
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.43 K
116
暂无简介
Dart
952
235
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
2