TracerLee/tracerlee.github.io

文档工具

Opened this issue · 4 comments

TracerLee commented

gitbook

一个好的工具是产出的关键一步，偶然发现gitbook这样的平台和工具，尝试使用gitbook给自己的文字产出增添光彩。可能用在如下地方：

  • 编写教程
  • 项目API文档
  • 写书
  • 记录

    安装

安装出现的意外

发现不同node版本的安装过程出现了不一样的结果。

0.12.*版本的安装gitbook会出现异常抛出。

截至笔者写稿时间（2016年4月2日04:51:43）node版本为4.4.2，安装gitbook无异常。

将gitbook转移到移动设备上阅读

今天（2016年4月2日18:20:21）突发奇想，能不能借助手机或者平板等移动设备随时离线随地阅读gitbook呢？答案是可以的，而且也不是很复杂，具体操作如下（以iPhone为例）：

  • 进入你所感兴趣的gitbook主页，比如：前端开发笔记本
  • 主页右侧其实提供了多种格式进行阅读
    • Read按钮，直接以网页形式打开gitbook，在国内网速堪忧
    • PDF按钮，下载PDF格式gitbook到本地，适合各种设备
    • ePub按钮，下载ePub格式gitbook到本地，适合iBooks等软件，阅读体验较佳
    • Mobi按钮，下载Mobi格式gitbook到本地，适合Kindle
  • 以ePub格式为例，点击ePub按钮，下载文件到本地，将文件传输到iPhone，用任何传输方式都可以（我用QQ传送）
  • 在iPhone上点击文件，使用其他应用打开，选择拷贝至iBooks，完成任务，可以愉快地到iBooks上享受阅读了
  • BTW，iPhone下的iBooks软件阅读ePub格式的体验不错，渲染出的阅读页面十分舒服，唯一不足的是无法通过iBooks直接分享书籍，只能在其他途径分享文件
TracerLee commented

MkDocs

Desc : Project documentation with Markdown. http://www.mkdocs.org

Github : https://github.com/mkdocs/mkdocs

点评：这个工具生成方便，用 markdown 手写文档，外观还行，可配置主题。PS : 用 python 安装有一点点麻烦，要用国内镜像。

TracerLee commented

docsify

Desc : A magical documentation site generator. https://docsify.js.org

Github : https://github.com/mkdocs/mkdocs

点评：这个工具同样使用命令行，使用 nodejs 安装简单，用 MarkDown 手写文档，外观优雅，和 mkdocs 有得比，国人作品，支持。

TracerLee commented

Docusaurus

Desc : Easy to maintain open source documentation websites. https://docusaurus.io

Github : https://github.com/facebook/docusaurus

点评：Facebook 出品 ……

TracerLee commented

ShowDoc

Desc : ShowDoc is a tool greatly applicable for an IT team to share documents online https://www.showdoc.cc

Github : https://github.com/star7th/showdoc

点评：可在线使用的文档工具，外观一般，功能强大，也值得尝试。