如何格式化markdown及其中的所有代码?

问题描述 投票:0回答:2

我的 github 存储库中有一堆 Markdown 文件。由于团队成员较多,Markdown 的语法和 Markdown 文件中的代码很难标准化。

我想要的是: 创建一个 github 操作,在推送时自动修改这些文件。

我找不到也可以格式化代码的降价美化器。 (例如,在“=”周围添加空格)

我能想到的解决方案是:

  1. 使用可以完成所有操作的 CLI 工具
  2. 使用一个工具进行markdown,使用一个脚本过滤其中的所有代码并解析到另一个工具
  3. 如果此类 CLI 工具不存在,则向这些在线美化器发送 http 请求

注意:我的 Markdown 中有 Java、Cpp、Swift 等。

有什么解决办法吗?如果可以提供脚本(如果需要),我将不胜感激。

谢谢。

formatting markdown github-actions
2个回答
1
投票

如果这些

markdown
文件位于
java
项目中,您可以尝试 spotless

例如,如果你有一个maven项目,一尘不染,只需运行

mvn spotless:apply
,它就可以自动修复你的Markdown文件的所有样式/格式问题。


0
投票

我一直在开发一个工具(mdsf),它允许您使用“普通”格式化程序格式化 Markdown 代码块。

它支持最流行的格式化程序,如 gofmt、rustfmt、google-java-format、swiftformat 等等(截至目前大约 80 个)。

https://github.com/hougesen/mdsf

© www.soinside.com 2019 - 2024. All rights reserved.