Mac下使用simiki搭建个人wiki

最新推荐文章于 2024-09-28 07:41:01 发布

STHSF

最新推荐文章于 2024-09-28 07:41:01 发布

阅读量4.4k

点赞数 1

分类专栏： web 文章标签： wiki github 个人知识管理

本文链接：https://blog.csdn.net/u013041398/article/details/73958706

版权

web 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

写在前面

本人搭建个人wiki也是机缘巧合，最近一直在尝试学习一点前端的知识，尝试着使用github弄个个人博客啥的玩玩，扩充自己的知识。同时，自己从事算法类的工作，其实也是程序猿的一种啦，这两天在网上查找资料的时候发现了tracholar的个人wiki，我觉得写得不错，同时也是整理自己平时学习的东西的一个好的方案。我也尝试了很多知识管理类的软件，比如百度云笔记，Evrnote等都觉得不是很方便。主要是搜索起来比较麻烦，不便于记忆。于是尝试使用这个个人wiki。这个东西挺好玩的你可以试试。

simiki介绍

Simiki 是一个简单的个人Wiki框架。使用Markdown书写Wiki, 生成静态HTML页面。Wiki源文件按目录分类存放, 方便管理维护。

目录结构

主要介绍一下content和output两个文件夹。

使用simiki新建初始化(simiki init)之后会出现四个文件或文件夹，其中content下存储的是源文件(目前只支持markdown)，后面使用simiki g编译的时候会将content下的文件编译成静态文件目录，并存放到output中。

simiki quick start

个人觉得simiki还是比较容易上手的，具体的安装见QuickStart

Mac下部署

本文中关于simiki的部署主要还是参考官网，但对于新手来说还是有一定的坑的，所以我把整个流程再详细的解释一遍。

在这之前本人已经在github中使用了sthsf.github.io，所以只需要重新新建一个wiki仓库。

在github中新建完wiki仓库后，clone到本地

git clone https://github.com/yourUsername/wiki.git

进入wiki文件夹，然后simiki初始化

cd wiki
simiki init
simiki q

这时候原来clone下来的wiki空文件夹里面会产生几个文件和文件夹。这时候如何将github.io与这个wiki仓库链接起来呢？

simiki官网给了一个方法：安装Fabric，并且在生成的_config.yml中添加deploy配置项：

deploy：
    - type: git
      remote: origin
      branch: gh-pages

该段代码的作用就是将output目录下生成的子文件或者子文件目录，基于git的方式，推送到远程仓库相应的分支下。

当然这里需要注意的是我们需要安装ghp-import，同时要确认本地和远程仓库关联了。
然后直接执行部署命令即可。

fab delpoy

此时就可以通过访问yourUserName.github.io/wiki来访问你的个人git了。

在windows下的部署可以参考tracholar同学的博客。写的也比较详细。

很多人要问那我写的东西如何发布到上面去呢？

网页发布流程

首先需要注意的是目前simiki仅支持markdown的格式，因此我们每次的文章都需要用markdown的形式来书写，同时还要注意每个markdown都需要添加类似于头文件的东西，如

---
title: "Getting Started"
layout: page
date: 2099-06-02 00:00
---

如果每个markdown中没有上面的文件内容，你在使用simiki g编译的时候会报下面的错误:

Traceback (most recent call last):
  File "/usr/local/bin/simiki", line 11, in <module>
    sys.exit(main())
  File "/Library/Python/2.7/site-packages/simiki/cli.py", line 404, in main
    generator.generate(include_draft=args['--draft'])
  File "/Library/Python/2.7/site-packages/simiki/cli.py", line 181, in generate
    self.generate_tags()
  File "/Library/Python/2.7/site-packages/simiki/cli.py", line 217, in generate_tags
    meta, _ = g.get_meta_and_content(do_render=False)
  File "/Library/Python/2.7/site-packages/simiki/generators.py", line 135, in get_meta_and_content
    meta_str, content_str = self.extract_page(self._src_file)
  File "/Library/Python/2.7/site-packages/simiki/generators.py", line 203, in extract_page
    raise Exception('extracting page with format error, '
Exception: extracting page with format error, see <http://simiki.org/docs/metadata.html>