个人wiki搭建资料整理

本文介绍了如何搭建个人wiki系统,包括大型企业级的Confluence和MediaWiki,以及小型个人级的Wikitten和Amwiki。重点讲解了使用MkDocs搭建过程,从安装、创建wiki、预览、添加内容到更换主题和托管到GitHub的详细步骤。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

个人wiki搭建

一、大型企业级wiki:

Confluence

Confluence是一个专业的企业知识管理与协同软件,也可以用于构建企业wiki。使用简单,但它强大的编辑和站点管理特征能够帮助团队成员之间共享信息、文档协作、集体讨论,信息推送。

MediaWiki

MediaWiki全球最著名的开源wiki程序,运行于PHP+MySQL环境。MediaWiki从2002年2月25日被作为维基百科全书的系统软件,并有大量其他应用实例。

二、小型个人级wiki

Wikitten:

Wikitten是一款开源Wiki知识管理系统,使用PHP开发,支持Markdown语法,无需数据库,自动生成树形目录,适合用来做个人Wiki知识库。

Amwiki:

amWiki 是一款由 JS 开发、依赖 Atom 或 Nodejs-Npm 的 Markdown 轻量级前端化开源文库系统。 amWiki 致力于让大家可以更简单、更便捷的建设个人和团队文库系统!

搭建自己的wiki知识管理系统(https://zhuanlan.zhihu.com/p/61492480)

本文小编将带大家从零开始搭建一个属于你自己的wiki系统。 开源的wiki系统有很多,比如:

小编选择使用的是MkDocs,因为它部署和使用都非常的简便,特别适合作为个人wiki知识管理系统。简单的说MkDocs就是将Markdown文件转换成静态的HTML网站,然后既可以在本地直接访问,也可以托管到服务器或者GitHub。

实战开始

1.安装MkDocs

1.1 Ubuntu系统

sudo apt-get install mkdocs

1.2 Windows系统

MkDocs目前支持Python2.7,3.4,3.6,3.7版本

  • 安装Python(请参考Python官网教程)
  • 安装pip
pip install --upgrade pip

  • 安装MkDocs
pip install mkdocs

1.3 确认是否安装正确

mkdocs --version

2.创建一个Wiki

mkdocs new my-wiki
cd my-wiki

成功创建后,就如下图所示:

img

  • docs文件夹下存放的就是自己写的Markdown文章,系统默认会生成一个index.md文件
  • mkdocs.yml是wiki网站的配置文件(主题、目录、语言等)

3.预览wiki

  • 首先启动mkdocs服务
mkdocs serve

  • 然后打开浏览器输入127.0.0.1:8000访问wiki

如果以上步骤都执行成功,你将看到如下界面:

img

至此,一个wiki系统已经搭建完成,下面我们来学习一下如何向wiki系统中添加新的内容吧!

4.添加新内容

4.1 添加新的文字内容

  • 首先在docs文件夹下面创建test.md文件,并使用你喜欢的markdown编辑器写入内容,如下所示:
This is a new page.

# 一级标题

## 二级标题

### 三级标题

  • 编辑mkdocs.yml文件,写入以下内容:
nav:
    - Home: index.md
    - First: first.md

  • 编辑成功后,你将看到如下界面:

img

4.2 插入图片

在docs文件夹下创建images文件夹,并将图片放入此文件夹,然后在markdown文件中引用:

![mkdocs](images/mkdocs.png)

  • 成功后,你将看到如下界面:

img

5.更换主题

mkdocs有多个主题可供选择,以满足不用用户的喜好,在此小编向大家推荐Material主题。

5.1 安装Material主题

pip install mkdocs-material

5.2 配置wiki使用Material主题

打开配置文件mkdocs.yml,写入以下内容:

theme:
  name: 'material'

6.将你的wiki站点托管到GitHub

cd my-wiki
git init
git add remote https://github.com/user_name/repository_name
git add .
git commit -m "first commit"
git push origin master

  • 部署你的wiki站点
mkdocs gh-deploy

现在你的wiki站点(HTML文件)在gh-pages分支,你的wiki站点(markdown文件)在master分支。

该命令执行了两个动作:

  1. 将Mardown文件转为静态HTML网页文件
  2. 将所有的静态HTML网页文件都推送到远程仓库的gh-pages分支

GitHub会自动管理gh-pages分支的静态网页,就相当于一个静态网站服务器。

  • 通过以下网址访问你的wiki
https://user_name.github.io/repository_name

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值