markdown如何支持代码块引用?

图片.png

例如:https://github.com/tiangolo/f...

看 fastapi 的时候,发现 doc 中的 markdown 引用代码块的时候,不是直接写死在 md 里面,而是使用 {!!} 这样的方式来外部引用

这种方式应该不是 markdown 原生支持的语法吧?

因为我在做一个开源项目,也希望想 fastapi 一样管理文档,如何实现?

是自己写一个脚本来实现替换吗?

阅读 2k
2 个回答

原生的 markdown 一般这样的都是借助的扩展插件,或者其他的编译脚本实现的这种功能。比如说 hexo 的引入外部在线 Demo 就会使用类似于 {% xxx %} 的形式。

主要还是看你的项目是使用的什么语言,然后在把 markdown 转换成 html 之前把这些插槽转换成对应的内容就可以了。

看你要选用哪一个基础markdown渲染框架(ps:或者自行实现)。正常解析类都会做语法解析,获取到语言元素,然后在按照规则(或者通俗的将模板也行)来渲染。在语言编译里面可能是转机器码,或者汇编啥得了。
所以看你用的框架支持不支持自定义,如果可以的话添加规则和解析映射过来的html模板应该就可以完成需求。

update: 可以参考 https://marked.js.org/using_p... 这个库的使用

或者说另一种方式,使用常规模板组件,替换{!!}里面的内容,再交给markdown渲染引擎进行渲染,也是可以的。

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题
宣传栏