快捷转换/互转 Markdown 文档和 TypeScript/TypeDoc 注释

简介: 作为文档工具人,经常需要把代码里面的注释转换成语义化的 Markdown 文档,有时也需要进行反向操作。以前是写正则表达式全局匹配,时间长了这种方式也变得繁琐乏味。所以写了脚本来互转,增加一些便捷性。

背景

作为文档工具人,经常需要把代码里面的注释转换成语义化的 Markdown 文档,有时也需要进行反向操作。以前是写正则表达式全局匹配,时间长了这种方式也变得繁琐乏味。所以写了脚本来互转,增加一些便捷性。

解决方案

注释转 Markdown

下载地址:https://github.com/mazeyqian/go-gin-gee/releases/tag/v1.2.0

操作步骤:

  1. 跟自身系统下载文件 convert-typedoc-to-markdown-mac-darwin-amd64/...
  2. 在同个目录下新建一个文件夹 data
  3. 在文件夹 data 内新建一个文件 td2md.js
  4. 在将需要被转换的注释放在文件 td2md.js
  5. 执行 convert-typedoc-to-markdown-mac-darwin-amd64/...
  6. 在文件 data/td2md.md 内查看最新结果

Convert TypeDoc to Markdown

Markdown 转注释

下载地址:https://github.com/mazeyqian/go-gin-gee/releases/tag/v1.3.0

操作步骤:

  1. 跟自身系统下载文件 convert-markdown-to-typedoc-mac-darwin-amd64/...
  2. 在同个目录下新建一个文件夹 data
  3. 在文件夹 data 内新建一个文件 md2td.md
  4. 在将需要被转换的注释放在文件 md2td.md
  5. 执行 convert-markdown-to-typedoc-mac-darwin-amd64/...
  6. 在文件 data/md2td.js 内查看最新结果

Convert Markdown to TypeDoc

使用案例

GitHub:https://github.com/mazeyqian/mazey/tree/v3.7.4/scripts/convert

GitHub Case

版权声明

本博客所有的原创文章,作者皆保留版权。转载必须包含本声明,保持本文完整,并以超链接形式注明作者后除和本文原始地址:https://blog.mazey.net/3494.html

目录
相关文章
|
2月前
|
JSON 前端开发 JavaScript
Docusaurus框架——快速搭建markdown文档站点介绍sora
Docusaurus框架——快速搭建markdown文档站点介绍sora
76 0
|
2月前
|
前端开发
914.【前端】Taro集成towxml渲染markdown文档
914.【前端】Taro集成towxml渲染markdown文档
208 2
|
2天前
|
JavaScript Java
Java 将Markdown文件转换为Word和PDF文档
【7月更文挑战第5天】Java中使用`Spire.Doc for Java`库可方便地将Markdown转换为Word或PDF。基本步骤包括导入模块,创建`Document`对象,加载Markdown文件,然后保存为目标格式(`.docx`或`.pdf`)。若遇到`Invalid UTF-8 stream`错误,需确保Markdown文件是UTF-8无BOM编码。页面设置可通过`PageSetup`类调整。注意,实际应用会依据具体需求和环境有所调整。
|
3天前
|
JSON 监控 数据挖掘
上网行为管理软件中的Markdown文档编写与格式化
Markdown是轻量级标记语言,用于快速排版和格式化文本,常见于技术文档和博客。基本语法包括:#(1-6个)创建标题,空行分隔段落,*或-创建列表,[文本](链接)插入链接,![文本](图片URL)插入图片。此外,还有代码块(```包围)、引用(>)等高级格式。Markdown支持HTML嵌入以自定义样式,并广泛应用于上网行为管理等领域的文档编写。通过自动化脚本,能将监控数据提交至网站进行分析。
22 6
|
6天前
|
自然语言处理 开发者 Python
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 内容。Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强。
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 内容。Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强。
|
6天前
|
Unix Linux Shell
Sphinx是一个Python文档生成工具,它可以解析reStructuredText或Markdown格式的源代码注释,并生成多种输出格式,如HTML、LaTeX、PDF、ePub等。
Sphinx是一个Python文档生成工具,它可以解析reStructuredText或Markdown格式的源代码注释,并生成多种输出格式,如HTML、LaTeX、PDF、ePub等。
|
17天前
|
存储 JavaScript Python
word文档转成Markdown文档并在Typora免费版添加图床-----想想都很香
word文档转成Markdown文档并在Typora免费版添加图床-----想想都很香
20 0
|
2月前
|
存储 对象存储 C++
在 VS Code 中使用 OSS 进行 Markdown 文档编写
阿里云OSS对象存储服务是理想的存储解决方案,专门用于承载大量非结构化数据。在VSCode中编写Markdown文档时,手动上传图片至OSS并获取相应链接的过程通常复杂且耗时。为此,Aliyun OSS Uploader插件应运而生,以简化和优化此流程。它不仅能够自动将图片上传到OSS并生成可供插入的链接,还能在您需要时通过撤回链接,删除已上传的图片,极大地提升了效率和便捷性。
|
2月前
|
数据采集 数据挖掘 Python
Python之html2text: 将HTML转换为Markdown 文档示例详解
Python之html2text: 将HTML转换为Markdown 文档示例详解
116 0
|
10月前
|
Rust JavaScript Docker
提升 Markdown 文档协作:Let's Markdown介绍与部署
Let's Markdown 是一个开源项目,旨在简化 Markdown 文档的创建、编辑和共享。快速、最小的网络编辑器,使标记编辑协作,每个人都可以访问。它提供了一套工具和功能,使 Markdown 文档的处理变得更加轻松和高效。使用Rust和React.js构建。有关详细信息,请参阅GitHub仓库。
279 3
提升 Markdown 文档协作:Let's Markdown介绍与部署