本项目是 amWiki 轻文库的定制版本,用于实现在服务器端运行的轻量级 Wiki 文库。
-
在服务器上安装 nodejs 及 PM2 进程管理工具
-
下载本项目源码并拷贝至服务器(以下示例为放入
/usr/local/src/
目录,为规范化 nodejs 模块考虑,也可以放入 node_modules 目录),并根据需要建立软连接,如:ln -s /usr/local/src/amWiki/bin/main.js amwiki2
-
在服务器上创建 amWiki 项目目录:
mkdir /home/wiki
-
切换至 amWiki 项目目录,初始化目录:
cd /home/wiki amwiki2 -i 我的 Wiki 文库
根据需要配置 wikis.json 配置文件:
name
- amWiki 项目名称domain
- amWiki 项目服务端域名或地址(不配置则直接展示本地IP)
-
创建新 Wiki 文库:
amwiki2 create 我的知识库1 amwiki2 create 我的知识库2 V0.1
根据需要配置各个文库的 config.json 配置文件,配置方法参阅config.json 配置。
-
编辑修改新文库并更新:
amwiki2 update 我的知识库1 amwiki2 update 我的知识库2
-
使用 PM2 启动 amWiki 服务:
pm2 start 'amwiki2 -s'
随后,即可在浏览器中访问文库:http://<服务器IP>:5171/(端口可根据需要在步骤 7 中调整)。
更多 amWiki 项目信息请参考原项目:https://github.com/TevinLi/amWiki
以下为原项目 README 文档。
amWiki 是一款由 JS 开发、依赖 Atom 或 Nodejs-Npm 的 Markdown 轻量级前端化开源文库系统。
amWiki 致力于让大家可以更简单、更便捷的建设个人和团队文库!
- 文档系统采用 markdown 语法
- 不用数据库,文档使用
.md
格式保存本地文件 - 无需服务端开发,只需支持 http 静态访问网页空间
- 一键创建新的文库
- 自动更新文库导航目录
- 支持多级目录
- 支持截图直接粘帖为本地 png 并插入当前 markdown
- 文档web端自适应显示,适合所有平台
- 支持接口文档自动抓取内容生成简单的ajax测试
- 无需服务端的全文库标题内容搜索与计分排序
- ... (更多内容期待您的发现)
amWiki 可以同时在 Atom 编辑器和 nodejs npm 的命令行两个平台工作,两个平台的工作相互独立,但所创建的文库却可以相互共用
(PS:对这两个平台的依赖都是编辑需求而不是服务器需求,amWiki 创建的文库是纯静态 html,可以布置到任意服务器)
- 下载 Github 开源文本编辑器 Atom,并安装
- 安装 Atom 插件 amWiki,并在完成后重启 Atom
- 前往 Github 的 amWiki版本发布页 下载最新版压缩包,解压到 C:\Users\Administrator.atom\packages,并将文件夹名
amWiki-1.x.x
改为amWiki
- 或者,Atom 菜单,File -> Setting -> Install -> 搜索
amWiki
-> 找到 amWiki 并 Install - 或者,在 cmd 或终端中命令:
apm install amWiki
(第三字母 W 大写)
- 前往 Github 的 amWiki版本发布页 下载最新版压缩包,解压到 C:\Users\Administrator.atom\packages,并将文件夹名
- 在 Atom 菜单,File ->
Add Project Folder
添加一个项目文件夹 - 在此文件夹下创建一个名为
config.json
的文件 - 在 Atom 菜单,amWiki轻文库 -> 通过“config.json”创建新文库
- 下载 nodejs 并安装
- 执行命令:
npm install -g amwiki
(第三字母 w 小写) - cd 到某个文件夹,通过命令
amwiki create
创建文库 - 通过命令
amwiki help
查看帮助
更多详细功能与使用介绍请前往: [ amWiki 官网文档中心:amwiki.org/doc/ ]
(amWiki 的文档由项目自身创建与维护)