沙滩星空的博客

2024-08-08 沙滩星空 阅读(394) 评论(0)

引言文档或者WIKI系统，现在流行直接用MarkDown创作。毕竟MarkDown语法，几分钟就能学会。总有一堆人，他们认为，产品手册，以后是要打印的，所以，还是MS Word好。他们认为，MarkDown对于运营与...

2023-11-07 沙滩星空 阅读(1111) 评论(0)

简介Jupyter Notebook 是一个开源的、基于网页的应用。它可以创建一个文档，在这个文档里，我们不但可以使用 Markdown 语法来输入文本，插入图片，还可以运行多种编程语言代码，并直接在文档里查看代码运...

2023-05-23 沙滩星空 阅读(950) 评论(0)

简介docsify 直接通过 JS 解析 Markdown 文件， 而不必编译生成 html,css,js 等静态资源文件。它可以自动地将 Markdown 中的标题生成目录，配合 GitHub Pages 或 码云...

2022-12-01 沙滩星空 阅读(1085) 评论(0)

在 pkg.go.dev 上的文档，都是 Go 自动从开源项目的工程代码中爬取、格式化后展现出来的。每个人都可以写自己的 GoDoc 并且展示在 pkg.go.dev 上，只需要遵从 GoDoc 的格式标准即可，也不...

2022-11-19 沙滩星空 阅读(810) 评论(0)

创建Git仓库Github上创建仓库，仓库名为 username.github.io, 其中 username 必须为实际GitHub账号的用户名。安装hugo很多主题需要 扩展版 的hugo才能安装。故应安装 扩展...

2021-03-26 沙滩星空 阅读(836) 评论(0)

apiDoc是一个基于NodeJS的跨语言的，通过读取项目源码注释自动生成API文档的工具。安装：npm config set registry https://registry.npm.taobao.org npm...

2021-02-26 沙滩星空 阅读(836) 评论(0)

文档生成器在构建软件项目时，简单的，我们直接在项目主页上，直接创建一个 README.md 文件即可。但是，对于复杂点的项目或者工程，我们经常需要提供完善的操作手册或开发文档。一个 README.md 就显得力不从心...

2020-01-16 沙滩星空 阅读(871) 评论(0)

1. MinDoc功能和界面源于 kancloud, 用Golang开发https://github.com/mindoc-org/mindoc2. YAPIhttps://github.com/ymfe/yapih...