New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
文档工具 #6
Comments
MkDocsDesc : Project documentation with Markdown. http://www.mkdocs.org Github : https://github.com/mkdocs/mkdocs 点评:这个工具生成方便,用 markdown 手写文档,外观还行,可配置主题。PS : 用 python 安装有一点点麻烦,要用国内镜像。 |
docsifyDesc : A magical documentation site generator. https://docsify.js.org Github : https://github.com/mkdocs/mkdocs 点评:这个工具同样使用命令行,使用 nodejs 安装简单,用 MarkDown 手写文档,外观优雅,和 mkdocs 有得比,国人作品,支持。 |
DocusaurusDesc : Easy to maintain open source documentation websites. https://docusaurus.io Github : https://github.com/facebook/docusaurus 点评:Facebook 出品 …… |
ShowDocDesc : ShowDoc is a tool greatly applicable for an IT team to share documents online https://www.showdoc.cc Github : https://github.com/star7th/showdoc 点评:可在线使用的文档工具,外观一般,功能强大,也值得尝试。 |
gitbook
一个好的工具是产出的关键一步,偶然发现gitbook这样的平台和工具,尝试使用gitbook给自己的文字产出增添光彩。可能用在如下地方:
安装出现的意外
发现不同node版本的安装过程出现了不一样的结果。
0.12.*版本的安装gitbook会出现异常抛出。
截至笔者写稿时间(2016年4月2日04:51:43)node版本为4.4.2,安装gitbook无异常。
将gitbook转移到移动设备上阅读
今天(2016年4月2日18:20:21)突发奇想,能不能借助手机或者平板等移动设备随时离线随地阅读gitbook呢?答案是可以的,而且也不是很复杂,具体操作如下(以iPhone为例):
The text was updated successfully, but these errors were encountered: