Windows 搭建 amWiki 轻文库

Windows 搭建 amWiki 轻文库

Windsys Project 那边有一个坑需要写一波帮助文档,如果用 WordPress 管理或查阅的话不太方便,于是乎就找到了一个轻量级的Wiki系统:amWiki

2021/03/12:文章已过时,现在的话还是 vuepress 香

环境搭建

amWiki 是一款由 JS 开发、依赖 Atom 或 Nodejs-Npm 的 Markdown 轻量级前端化开源文库系统,本次我们将在 Node.js 环境下搭建

1、安装Node.js

访问 Node.js 官网下载Windows版本并安装

https://nodejs.org/

安装完毕后打开 CMD 输入 npm -v

出现版本号就证明安装成功

2、安装 Visual Studio Code 和 amWikiForVSCode 插件 用于管理文库 (可选)

同上先访问官网安装

Visual Studio Code https://code.visualstudio.com/

安装完 VS Code 后打开,在扩展安装处搜索 amWikiForVSCode 并安装

我个人打算用 VScode 来管理该文库,当然你也可以用官方推荐的 atom 来管理文库 然后我们的环境就搭建完毕了,接下来就安装 amWiki 系统。

安装 amWiki 系统

1、打开 CMD
2、输入 npm install -g amwiki 安装 amwiki;

安装完毕后如图(可用 `amwiki -v` 命令来检查是否安装成功)

安装完 amWiki 后咱们要建立一个新的文库才能开始使用

建立文库

新建一个空文件夹作为文库目录,然后打开VScode,在“文件-打开文件夹”处打开刚新建的文件夹

打开文件夹后新建一个 config.json 文件

新建完后写入配置到该文件,如:

1
2
3
4
5
6
7
{
"name": "文档中心",
"ver": "",
"logo": "logo.jpg",
"colour": "default",
"testing": true
}

然后咱们可以适当编辑

1
2
3
4
5
name:文库名称,不设置将显示默认名称
ver:文库版本号或维护者名称,设置为空字符串将不显示,不设置将显示 amWiki 作者
logo:logo 的 url,不设置将显示默认 logo
colour:自定义颜色,默认为蓝色 ,支持 # 开头的 6 位 16 进制 web 色、RGB 色两种模式
testing:是否启用接口测试模块,默认值 false

编辑好后保存该文件,然后到左边的文件栏右击刚刚的配置文件,选择“基于当前config.json创建wiki”

BOOM!就创建完成了

访问文库

打开 CMD ,进入文库目录,输入: amwiki -s 访问该网址,就能看到咱们的文库了。

到这 amwiki 我们就搭建完了,更多玩法或使用教程请参考 amwiki 文档中心

http://amwiki.org/doc/

Windows 搭建 amWiki 轻文库

http://blog.whatk.me/2018/windows-amwiki/

作者

Whatk

发布于

2018-07-26

更新于

2021-06-30

许可协议

评论