#markdown #json #generated #parser #file #cli #typedoc

app typedoc_json_to_md

将typedoc-json-parser生成的TypeDoc JSON转换为Markdown

6个版本

0.3.3 2024年6月3日
0.3.2 2024年6月3日
0.2.0 2024年6月2日
0.1.0 2024年6月2日

#811解析实现

每月24次下载

MIT 许可证

21KB
344 代码行

TJP-TO-MD

一个CLI工具,用于将Typedoc JSON Parser生成的Markdown转换为Markdown文件

理由

  • MD文件比专门的JSON文件更容易在网站上显示。
  • 过去使用ESM仅模块与next一起使用给我带来了问题。
  • 允许在GitHub/任何Markdown查看器中查看
  • 允许项目更容易地复制文档的相关部分

配置

可以通过将一个tjp_to_md.toml文件放入解析将发生的文件夹的根目录来配置CLI。它应该看起来像这样

input_dir= "<your input directory>"
output_dir = "<your output directory>"
max_threads = 5
regen_all = false

或者,你可以运行tjp-to-md gen_config

许可证

此项目根据MIT许可证授权:)

依赖关系

~2–12MB
~86K SLoC