最新消息:20210816 当前crifan.com域名已被污染,为防止失联,请关注(页面右下角的)公众号

【整理】文档制作工具相关:MkDocs Gitbook Hexo等

gitbook crifan 4699浏览 0评论

iOS SDK 概述 – 极光文档

-》

MkDocs

mkdocs/mkdocs: Project documentation with Markdown.

Home · mkdocs/mkdocs Wiki

MkDocs

mkdocs/mkdocs: Project documentation with Markdown.

mkdocs 中文

使用mkdocs实时发布项目文档 | I think.

mkdocs与jekyll 创建静态网站 – 黑黑的豆的个人空间 – 开源中国社区

MkDocs – V2EX

MkDocs Themes · mkdocs/mkdocs Wiki

mdwiki

使用mkdocs实时发布项目文档 | I think.

让mkdocs支持中文搜索

MkDocs 中文文档 (需要翻墙)

MkDocs 中文文档

概述 – Markdown 中文文档

markdown 生成文档

使用Markdown进行写作和文字记录 – 知乎专栏

利用 Gitbook 生成文档中心站点 | Bugtags官方博客

mkdocs VS gitbook

Markdown + Gitbook | Markdown 简单的世界

Ask HN: How does your team write documentation? What tools do you use? | Hacker News

mkdocs  对比 gitbook

An interface for reading documentation · Issue #52 · tootsuite/documentation

Android群英传神兵利器读书笔记——第一章:程序员小窝——搭建高效的开发环境 – 程序园

一个静态网站生成工具的对比网站 – Static Generator | itVincent的博客

Jekyll、Hugo、Hexo是用来制作博客类站点的

GitBook、MkDocs是用来写文档类

【博客系统Hexo】

https://gitbook.zhangjikai.com/bookjson.html

-》http://www.zhangjikai.com

-》http://blog.zhangjikai.com

-》

NexT.Mist 

https://github.com/iissnan/hexo-theme-next

Hexo

https://hexo.io

-》https://hexo.io/docs/

-》是个博客系统,类似于Wordpress

但是是轻量级,清爽感觉的

用Markdown书写内容

Hexo生成静态文件

“Hexo 是一个快速、简洁且高效的博客框架。Hexo 使用 Markdown(或其他渲染引擎)解析文章,在几秒内,即可利用靓丽的主题生成静态网页。”

https://github.com/iissnan/hexo-theme-next/blob/master/README.cn.md

还支持从其他地方,包括wordpress导出到Hexo

迁移 | Hexo

后来也看到别人用hexo制作自己的博客系统,然后放到github.io上的:

KaKa’s blog

【后记】

后来从:

关于我们 – OpenWrt.io

-》

openwrtio/portal: openwrt.io 主站,提供开发文档

也是用mkdocs生成的

-》

MkDocs

不过两者有何区别:

mkdocs vs gitbook

mkdocs 对比 gitbook

GitBook and MkDocs – reviews/pros and cons – Google Groups

Academis • Tools for documenting software

Gitbook——你自己的开源电子书 // Xuanwo’s Blog

Top Ten Static Site Generators of 2017 | Netlify

一个静态网站生成工具的对比网站 – Static Generator | itVincent的博客

首页 | Read the Docs

Build Process — Read the Docs 1.0 documentation

【总结】

属于Static Site Generator的:(静态网站生成工具的对比网站StaticGen中有更多总结)

  • 制作博客类站点

  • 制作文档类站点

    • 基于markdown的

      • Gitbook

        • 也自带一套gitbook工具,用于将md转为html/PDF/其他格式

      • Mkdocs

        • 把md转换为html(网站)

生成文档的工具/技术/框架:

存放静态网站:

  • Readthedocs

    • 创建、托管和浏览文档

      • 存放不同语言的各种库的文档(静态页面)的网站

    • 内部支持使用Sphinx/Mkdocs去(通过你上传到代码和配置去编译生成文档)

相关:

转载请注明:在路上 » 【整理】文档制作工具相关:MkDocs Gitbook Hexo等

发表我的评论
取消评论

表情

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址
82 queries in 0.154 seconds, using 22.01MB memory