mysql文档生成工具——mysql_markdown

mysql_markdown是一个基于GO的命令行工具,用于生成数据库结构的Markdown文档。通过Typora,可以将.md文件转换为Word、HTML或PDF。本文介绍了下载、编译mysql_markdown并使用其生成文档的步骤。
摘要由CSDN通过智能技术生成

说在前面的话~

mysql_markdown是一款基于GO语言命令行工具,他能生成数据库结构文档,生成的文件为.md(markdown)格式。我们可以通过Typora工具(一款好用的markdown编辑器)将md文件转成word,html,pdf等格式的文件。

先上效果

先说mysql_markdown的下载(我的是windows):

拉取mysql_markdown的git项目到本地

git clone https://github.com/alicfeng/mysql_markdown.git

接下来就是编译mysql_markdown里的mysql_markdown.go文件,所以要安装go语言

GO安装地址:https://golang.org/dl/

一直下一步就好,而且GO不需要配置环境变量。

GO安装完成后,运行 go version看是否安装成功

C:\Users\Admin
TypeDoc 是一个基于 TypeScript 的文档生成器,它可以根据 TypeScript 代码自动生成文档,并支持生成多种格式的文档,如 HTML、Markdown 等。TypeDoc 支持以下功能: - 自动生成文档:TypeDoc 可以自动读取 TypeScript 代码中的注释,并将其换为文档。 - 支持多种格式:TypeDoc 支持生成多种格式的文档,如 HTML、Markdown、JSON 等。 - 支持主题定制:TypeDoc 支持使用主题来定制文档的样式和布局。 - 支持插件扩展:TypeDoc 支持使用插件来扩展其功能。 使用 TypeDoc 生成文档非常简单,只需要在 TypeScript 项目中安装 TypeDoc,然后使用命令行工具或配置文件来生成文档即可。以下是一个使用 TypeDoc 生成文档的示例: ``` npm install typedoc --save-dev npx typedoc --out docs src/ ``` 上面的命令会在项目的 `docs` 目录下生成文档文档内容基于 `src` 目录下的 TypeScript 代码和注释。你也可以使用配置文件来生成文档,例如: ``` { "out": "docs", "include": "src", "exclude": "**/*.test.ts", "theme": "default", "readme": "README.md", "name": "My Project", "mode": "file", "excludePrivate": true } ``` 上面的配置文件指定了文档生成的一些选项,例如输出目录、包含的文件、排除的文件、主题等。在项目根目录下执行以下命令即可根据配置文件生成文档: ``` npx typedoc --config typedoc.json ``` TypeDoc 还支持许多其他选项和插件,可以根据具体需求进行配置和使用。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值