Skip to content

maoshuai/imshuai-wiki

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

wiki-site

Here is my wiki site for note-taking and sharing

Why Wiki

从上大学时,我就坚持使用笔记类软件记录和总结。从最早的单机版网文快捕、网博士到后来的为知笔记、Evernote等。这么多年,零零散散的也积累了四五千条的笔记资料,是一笔财富。笔记类软件,也成了我最不可或缺的学习工具,我甚至无法想象没有笔记软件的情形。

但总感觉缺点什么,仔细思索,最大的问题就是:笔记是私有的 。虽然,我也写了博客来分享,但我越发的觉得博客无法承载太多东西。经过长时间的思考,我想到了个人Wiki。与Wikipedia等不同,个人Wiki更多的像一个公开的笔记库,着重于个人的学习沉淀和交流。个人Wiki之于Evernote,就像开源之于闭源。知识类笔记本身无太多隐私可言,开源出来,岂不妙哉?

与个人博客的关系

个人博客,是分享和交流的好平台,也是促进个人成长和提升个人品牌的极好工具。以我最喜欢的阮一峰的网络日志来说,它可以说是IT界的教程标杆。通过不断的高质量产出,阮一峰现在的学习和输出的质量和功率令人叹为观止。

阮一峰的每一篇博客都具有极高的品质,目前我是无法达到的。在我看来,博客作为更正式的载体,不适合放置一些零散的知识。比如之前遇到了一个AIX的awk的坑16进制分隔0x0f符无效,可能只是一下调整某个参数,录一下即可,并不适合作为一篇博客长篇大论。但是,真的遇到了又很抓狂。我如果记录下来,或许可以帮助到其他人。

这种零散的笔记很频繁,放到博客里,显得太琐碎。作为博客的读者,他们也不希望被无头绪的文字淹没。可是,高质量的、有体系的知识,又是从零散的知识生长而来的。因此,我需要一个更有针对性的载体:Wiki。

与个人笔记的关系

就像前面所说,两者就像开源与闭源的关系。个人Wiki,从我的角度来看:

  • 更加精致化的输出和整理。个人笔记,难免过于粗糙(毕竟只有自己看得到,要求就低多了)。
  • 能得到读者的监督和指正。
  • 降低写作难度,为博客提供素材。
  • 提升个人品牌。

而从读者的角度来看:

  • 能获取到一些细小的知识总结。

Wiki工具的选择

开始构思搭建Wiki,我就进入Wiki工具的选择之旅。我的选择标准是:

  1. 部署简单,最好是不需要自己维护服务器(主要是没时间,而且费钱)。
  2. 数据格式独立和自由,不绑定某个平台,可轻易迁移。
  3. 文字结构简单,有层次感,最好是支持Markdown。
  4. 操作方便,不要太多额外步骤。
  5. 有良好的搜索功能。

进过一番调研,我罗列了十几个我调研的Wiki工具(需要的朋友可以自己评估,也许有你喜欢的):

  1. dokuwiki
  2. mediawiki
  3. mdwiki
  4. amwiki
  5. wikitten
  6. Wiko
  7. simiki
  8. vimwiki
  9. MoinMoinWiki
  10. simiki
  11. Gitit Bigger
  12. Wiki.js
  13. TiddlyWiki

这些工具,有些部署太复杂,甚至需要Mysql数据库,数据格式不自由,我不喜欢;有的局限于某个平台,我不喜欢。

最终有两个让我比较了很久:TiddlyWiki和vimwiki,两者相同点是都支持Generate静态html,但TiddlyWiki需要通过一个单页面HTML编写和生成,有点别扭。而vimwiki是基于vim的,本来已经打算使用了。最后无意间看到了Harttl Land,感觉很不错,我再次回到了Jekyll的怀抱。结合 Git Page 的自动生成功能,基本满足了我1到4的需求。而第5点搜索功能,Jekyll也是可以通过插件实现的,后续我再琢磨吧。实在不行,不还是有Google嘛。

本地预览

本地可以通过安装jekyll预览HTML输出效果。

  1. 按照jekyll官网步骤先配置jekyll环境:

    https://jekyllrb.com/docs/

  2. 安装gem依赖(进入docs目录操作)

    bundle install
  3. 然后起本地是server(进入docs目录操作)

    bundle exec jekyll serve
    

    根据提示,一般浏览器打开:http://localhost:4000

最后

让我们开始Wiki吧!

最后,再次感谢Harttl Land提供的Jekyll主题。

About

Here is my wiki under my site for note-taking and sharing.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published