随笔分类 -  开发文档管理

1 2 下一页

md2pdf python markdown 转pdf 包简单试用
摘要：md2pdf 是基于weasyprint 开发的一个markdown 转pdf 工具，功能上还是比较强大的，支持自定义效果，同时还支持基于jinja2 模版引擎的数据处理，在基本的转换完成之后内部会使用weasyprint 基于html 转换pdf 参考使用 安装 pip install git+h 阅读全文

posted @ 2024-10-16 05:56 荣锋亮 阅读(228) 评论(0) 推荐(0) 编辑

changie 简单试用
摘要：changie 是基于golang 开发的，官方提供了多种安装模式（rpm/deb 包），brew 包，npm 包，以下是一个简单试用 安装 可以结合上边说的，我使用了brew 安装命令 brew tap miniscruff/changie https://github.com/miniscruf 阅读全文

posted @ 2024-05-27 08:00 荣锋亮 阅读(15) 评论(0) 推荐(0) 编辑

changie 预处理release changelog 工具
摘要：changie 提供了比较友好的changelogs 说明 changelog 的一些原则 记住日志是写给人而非机器的 每个版本都应该有独立的入口 同类改动应该分组放置 不同版本应分别设置链接 新版本在前，旧版本在后 应包括每个版本的发布日期 注明是否遵守语义化版本规范 changie 提供的一些c 阅读全文

posted @ 2024-05-26 08:00 荣锋亮 阅读(17) 评论(0) 推荐(0) 编辑

dbt docs block 的一些技巧
摘要：dbt 的docs 实际上自定义上还是很强大的，可以灵活的docs block 解析，同时docs 定义也可以类似model 那样进行引用，当然也包含了一些内部固定模式可以灵活的进行文档的自定义 一些内置自定义玩法 自定义文档路径 类似dbt 其他资源一样docs 也是支持自定义的，否则默认会搜索m 阅读全文

posted @ 2024-04-20 08:00 荣锋亮 阅读(15) 评论(0) 推荐(0) 编辑

adr 方便的架构决策记录方法
摘要：adr 是编译中方便的架构决策记录方法，同时也纳入了技术雷达中，是一个很值得使用的模式 包含的内容 一般会包含标题，状态，上下文，决策，以及影响，aws 官方包含了很不错的例子，值得学习下 格式 对于存储格式没明确要求，实际上github 有一个adr 的组织，包含了不少实现工具，很值得参考学习对于 阅读全文

posted @ 2023-05-31 21:11 荣锋亮 阅读(72) 评论(0) 推荐(0) 编辑

tldr 方便的man 工具
摘要：使用tldr 可以方便的查看友好的文档 参考使用 安装 npm install -g tldr 更新cache sudo tldr -u 使用 比如查询rmmod 命令使用 说明 tldr 是一个比较方便的man 工具，提供了比较友好的命令查询，同时我们也可以自己定义帮助信息，支持的客户端也不少 参 阅读全文

posted @ 2023-04-23 21:51 荣锋亮 阅读(43) 评论(0) 推荐(0) 编辑

backstage 面向开发者门户框架再次简单试用
摘要：很早以前我试用过backstage，同时写过简单的介绍，随着目前backstage 越来越强大，而且进入了linux 基金会，同时还是cncf 孵化项目 对于backstage需要重新深入学习研究下了，以下只是简单的运行 参考使用 初始化项目 官方提供了cli 脚手架工具，很方便 按照提示操作就行 阅读全文

posted @ 2022-11-01 22:51 荣锋亮 阅读(273) 评论(0) 推荐(0) 编辑

readme.so docker 镜像
摘要：readme.so 官方是提供了docker 构建的，搜索了下发现暂时还没有docker镜像就自己搞了一个 参考使用 docker run -d -p 3000:3000 dalongrong/readme.so 效果 说明 已经推送docker官方了，可以直接使用 参考资料 https://git 阅读全文

posted @ 2021-06-06 00:13 荣锋亮 阅读(202) 评论(0) 推荐(0) 编辑

使用 readme.so创建 readme文件
摘要：readme.so 是一个web网站，可以用来方便的生成标准的readme 文件是一个很值得使用的工具（而且开源） 参考效果 参考资料 https://readme.so/https://github.com/octokatherine/readme.so 阅读全文

posted @ 2021-06-06 00:00 荣锋亮 阅读(330) 评论(0) 推荐(0) 编辑

godoc的写法
摘要：一个不错的项目，可以用来学习godoc文档的写法 一些说明 参考例子 func ExampleFoo() // 作为Foo函数或者类型例子 func ExampleBar_Qux() // 作为Bar类型的Qux函数例子 func Example() // 作为整个库的例子 通过这种规则，godoc 阅读全文

posted @ 2020-11-14 21:51 荣锋亮 阅读(255) 评论(0) 推荐(0) 编辑

golang-standards 提供的golang 项目结构布局
摘要：golang-standards 社区提供了一个golang 项目的参考结构，同时提供了比较完整的说明 go 目录 /cmd 项目的主干，次目录应该足够简单 /interenal 内部的，不需要分享到外部的，这个属于golang 内部的一个特性，我们也会在好多开源项目中看到 /pkg 可复用的一些代 阅读全文

posted @ 2020-09-10 09:07 荣锋亮 阅读(784) 评论(0) 推荐(0) 编辑

docz 强大简单的文档管理工具
摘要：使用docz我们可以用来方便的编写以及发布文档，同时提供漂亮友好的交互，可以快速的制作一个产品级的 站点,使用了了mdx 文件（还是markdown）,同时可以方便的集成到自己的web 项目中 安装试用 安装 npx create-docz-app my-docz-app npx create-do 阅读全文

posted @ 2019-10-27 10:28 荣锋亮 阅读(3517) 评论(5) 推荐(0) 编辑

使用rbenv 进行ruby 多版本的管理
摘要：今天需要安装一个ruby 包，但是ruby 版本过低，以前使用过rvm，但是在安装rvm 的时候发现系统有异常 错误信息，发现还有另外一个不错的可选工具 rbenv 安装 我是mac 系统 使用brew 安装 brew install rbenv brew install rbenv brew in 阅读全文

posted @ 2019-06-28 19:56 荣锋亮 阅读(1098) 评论(0) 推荐(0) 编辑

使用readthedocs 发布 sphinx doc文档
摘要：readthedocs 是由社区驱动的开源sphinx doc 托管服务，我们可以用来方便的构建以及发布文档 这是一个简单的demo 项目，使用了用的比较多的sphinx_rtd_theme 主题，主要是试用 注册账户 sphinx 文档需要让readthedocs 托管，我们需要一个账户，注册地址 阅读全文

posted @ 2019-06-12 10:55 荣锋亮 阅读(2164) 评论(0) 推荐(0) 编辑

sphinx doc 文档生成脚手架工具
摘要：sphinx 在python 语言开发中，是一个使用的比较多文档生成脚手架工具，我们帮助我们生成 专业的帮助文档，同时也有远端的免费saas 托管服务，方便分发 安装 sphinx 的安装好多方便，mac 的可以使用brew，或者我们可以使用pip 安装,详细的可以参考官方文档 mac brew 安 阅读全文

posted @ 2019-06-10 15:29 荣锋亮 阅读(1703) 评论(0) 推荐(0) 编辑

tbls ci 友好的数据库文档化工具
摘要：tbls 是用golang 编写的数据库文档化工具，当前支持的数据库有pg、mysql、bigquery 此工具同时提供了变更对比、lint 校验，生成是markdown格式的 简单使用 安装 mac 系统使用brew 安装 brew install k1LoW/tap/tbls brew inst 阅读全文

posted @ 2019-05-27 09:30 荣锋亮 阅读(1026) 评论(0) 推荐(0) 编辑

showdoc 开源在线api&&技术文档管理工具
摘要：showdoc 是一个很不错的api 以及技术文档管理工具 环境准备 doker-copose 文件 version: "3" services: doc: image: registry.docker-cn.com/star7th/showdoc volumes: - "./showdoc_dat 阅读全文

posted @ 2019-02-16 14:43 荣锋亮 阅读(2768) 评论(0) 推荐(0) 编辑

docusaurus 生成的website 通过circleci部署gh-pages
摘要：docusaurus 是facebook 开源的一款文档脚手架工具，可以快速的进行文档生成，基于markdown 同时已经内置了gh-pages 发布的命令，对于ci 工具，我们只需要简单的配置就可以了 环境准备 创建github空项目 很简单直接鼠标点击就可以了 创建docusaurus demo 阅读全文

posted @ 2018-11-20 10:10 荣锋亮 阅读(925) 评论(0) 推荐(0) 编辑

使用docusaurus 搭建开发&&api && 博客站点
摘要：对于日常的开发系统以及产品一个简单，方便的api&&文档网站可以七很大的作用 docusaurus 是facebook开源的文档管理框架，使用它我们可以快速的创建专业、 完备的文档站点 脚手架工具很不错，直接支持基于容器的构建&&运行，我们可以快速的创建、运行 创建简单站点 npx docusaur 阅读全文

posted @ 2018-11-08 18:14 荣锋亮 阅读(1191) 评论(1) 推荐(0) 编辑

dbt 的知识文档管理
摘要：dbt 支持docs的管理，可以方便进行分享，以及大家的可视化工作 有一篇文档讲的特别好分析了知识共享，知识管理的重要性（dbt 对应公司的ceo） https://blog.fishtownanalytics.com/scaling-knowledge-160f9f5a9b6c?_branch_m 阅读全文

posted @ 2018-10-20 20:08 荣锋亮 阅读(587) 评论(0) 推荐(0) 编辑

1 2 下一页

导航

< 2025年3月 >
日 一 二 三 四 五 六
23 24 25 26 27 28 1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31 1 2 3 4 5
点击右上角即可分享
微信分享提示