在线文档帮助生成/笔记软件使用一览
前言
现在时代发展飞快,每天都诞生出新东西,不得不去了解,当积累的知识多了,就想找一个软件来整理知识点,人不可能完全记住所有看过的东西,这时候记笔记的习惯就自然而然产生了。过去的时候我曾想找一个能记录知识,又能搜索的软件,当时看到了下面两张图的样子,这就是我想要的东西!!
这看起来很像chm帮助文档,没错,我也顺便想要个文档生成的工具,自己可以弄个wiki资料库,以便回头翻阅,当时搜了很久没找到满意的工具,到如今才出来这么多工具,心好痛……
我的需求如下:
- 树形目录,有二级三级等导航
- 全文搜索
- 响应式布局
- 不需要太多复杂的环境配置
- 支持中文
仅仅是这几样需求,就找了很久_(:з)∠)_每天都搜索有哪些工具都精神衰弱了,看下图我就找了好多文章……如今才诞生出那么多开源项目,早知道就坐等大佬造车好了233因为自己很懒,又不会编程,只想找个简单的工具写个笔记而已……(被踢飞)
在线文档帮助生成
现在每个网站都会有帮助文档,细心发现它们都有树形目录,模板都很漂亮,有时候就看看源代码开头用了什么工具创建的,自己也想弄一个资料库,所以就慢慢开始收藏心仪的开源工具。大部分是API类技术文档,只要会某一个编程语言都可以生成代码注释文档,但我不会语言就很苦恼了…就想找个简单的文档创作工具,不过好在我安装了Node,Node上有很多开源项目可以选择!那就太好了~
下面分两个目录,一个是在线类,一个是本地软件,有些还没找时间去尝试,有机会去试试,如果有推荐的欢迎在评论里补充!
在线类
工具软件 | 需要环境 | 使用体验 |
---|---|---|
mkdocs | Python | 搜索功能不全,不支持中文,可托管在read the docs |
dokuwiki | PHP | 这个完美支持中文,可离线运行,但是目录难弄 |
mediawiki | PHP | 维基百科的引擎框架,这个也无法自定义目录导航 |
moinmoin | PHP | 这个适合做wiki |
Tiddlywiki | PHP | 这个很有意思,卡片式wiki,不过这需要PHP就不考虑了 |
amwiki | Atom/Node.js | 国内开发的框架,感觉还行 |
sencha Extjs | Node.js | 没测试,看起来要自己写 |
Spinx | 支持中文,语言rst不太习惯,目录导航麻烦 | |
Swagger | 基于OpenAPI的API的开源编辑器 | |
Docfx | .NET | 微软开源文档工具,看样子不错 |
Gitbook | Node.js | 在线可创建书籍,可托管,但是网络速度不太行 |
slate | Ruby、NodeJS | 似乎只能在Linux 和 macOS 生成,windows不受支持 |
devdocs | Ruby 2.5.1, libcurl, ExecJS | 这个也是偶然看到的,这个也不错啊!但是也不知道怎么做的,但还需要构建环境好麻烦…… |
sdoc | Ruby | 适合做API文档 |
Jekyll相关主题 | Ruby | jekyll也有相关主题,但是有的搜索功能也不行,还需要借助algolia搜索引擎 |
JSDuck | Node.js | 仓库日期比较旧,很久不更新,无响应式界面 |
Antora | Node.js | 还没有测试 |
Docute | Node.js | 页面样式好看,不过导航可能是MD标题判断 |
docsify | Node.js | 推荐 这个不错,整体好看,大多文档都是用这个创建的,但SEO功能较弱 |
Vuepress | Node.js | 推荐 上面两个基本都基于或者仿做这个的,目前最广泛的框架,比较好的主题是vuepress-theme-hope |
Npm相关doc库 | Node.js | 我后来才想起来NPM可以搜索相关项目,不过有的过时了,有的也不支持中文 |
Hexo相关主题 | Node.js | Hexo是静态博客框架,HEXO主题也有文档相关主题,目前看中hexo-theme-doc和hexo-theme-Wikitten |
Docusaurus | Node.js | 推荐 Facebook开源的文档搭建网站,哇我才看到这个!一打开眼前一亮!这正是我需要的工具!感觉会成为我主要的创作工具了 |
有些文档看起来真挺不错的,但实际上感觉还行的样子,太多开源项目了,有机会再全面试试。
wiki类的工具都很不错,像dokuwiki、mediawiki等实际上是适合做百科资料库的,大多对目录导航不是很重视,都是类似建立词条一条一条跳转的。如果对导航需求不大可以考虑用它们。
国内也有在线文档的工具,比如金山文档、石墨文档、语雀等,这些只需要在线创建编辑即可完成,但只限于简单协作,如果要丰富点的功能还是需要从上面找心仪的工具。
软件类
这类是本地软件,不需要安装各类环境,离线安装即可创作,不过总体看下来有的不支持中文,有的搜索功能较弱,始终没找到满意的软件。
工具软件 | 使用体验 |
---|---|
Helpndoc | 这个最好,但搜索不支持中文,不知道是不是免费版的限制? |
Winchm | 制作chm本地帮助文件,可离线搜索,但没有响应式布局,还需要自定义CSS |
Helpsmith | 搜索功能较差,样式还行 |
West Wind Html | 看起来还行,感觉可能也不支持中文 |
Dr.Explain | 搜索不全,样式有点丑 |
MadCap Flare | 在国外排行第一的软件,好像很厉害的样子,哪天试试 |
Adobe Robohelp | 过去我在用这个软件,才知道adobe家还有帮助创作软件,但是弄完后就不想用这个软件了,太臃肿 |
笔记软件
然后是笔记软件了,顾名思义就是记笔记的东西,积累的知识多了就需要一个笔记软件来记录所有知识点,不然会忘记233时刻要回头看!国内也有笔记软件,如印象笔记、思源笔记、有道云笔记等,这些我都没有实际使用过,因为平时也用不到,就用电脑上的软件来记录,云笔记可能是因为在线记录方便吧?有机会我也去尝试看看。总得来说笔记软件是为了记录用的,并且让自己用着舒服,才是笔记软件的真正用武之地。
工具软件 | 使用体验 |
---|---|
Microsoft OneNote | 用来用去还是OneNote最舒服!巨硬大法好! |
Xmind | 思维导图软件,适合做规划,我也不怎么用。 |
Mybase | 使用了下,这个比较适合数据库管理。 |
Mempad | 适合日常碎片化记录,很小巧的软件,不占空间。 |
notion | 貌似很多人在用,我没用过,反响似乎不错的样子。 |
wolai | 也是很多人在用,但有收费没考虑。 |
Roam Edit | 新出的软件,观望中。 |
Rem Note | 功能强大,更新频繁,观望看看。 |
eDiary (电子日记本) | 经典的电子日记本,如今还在更新,新版UI界面还蛮好看的。 |
AllMyNotes | 一个综合性收费软件,是一种卡片式笔记。 |
CherryTree | CherryTree是一个支持无限层级分类的笔记软件,Python编写,支持富文本编辑和代码高亮,支持Mac、Linux、Windows平台。 |
trilium | 又是一款新出的笔记软件,UI界面很美观,还在开发中。 |
大概就这些吧,还是有很多没想起来,大家想到什么可以在评论补充!这些并不是全部,你也可以慢慢去发掘你喜欢的软件!还是要感谢开发者,感谢他们开发了好软件,让我们得以受益,科技是一大进步发明,期待未来也有很多神器诞生~
如果遇到评论加载不出来,请不要担心,稍等一会儿,等待服务器后台修复即可,或者过一段时间来看看~