A-A+

支持 Markdown 的优秀 Wiki 系统—— amWiki 轻文库

2018年02月05日 数码生活 暂无评论

最近西狂因为工作上的需要,在网上寻找一些 wiki 文档管理系统,通过筛选和比较,发现了一款优秀的开源项目—— amWiki,特意推荐给大家。

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

amWiki 的优势

  • 文档系统采用 markdown 语法
  • 不用数据库,文档使用 .md 格式保存本地文件
  • 无需服务端开发,只需支持 http 静态访问网页空间
  • 一键创建新的文库
  • 自动更新文库导航目录
  • 支持多级目录
  • 支持全库内容搜索
  • 支持本地模式,打开index.html直接浏览
  • 支持截图直接粘帖为本地 png 并插入当前 markdown
  • 文档web端自适应显示,适合所有平台
  • 支持接口文档自动抓取内容生成简单的ajax测试
  • 无需服务端的全文库标题内容搜索与计分排序
  • ... (更多内容期待您的发现)

amWiki 项目结构

amwiki 的目录结构很简单:

  • index.html文件,用于展现文档结构;
  • config.json文件,用于修改项目的相关设置;
  • amWiki文件夹,主要用于存放项目的cssjs文件;
  • library文件夹,用于存放用户的.md文档。

一个空的项目部署好后,只占用 1M 空间。

安装 amWiki

amWiki 可以同时在 Atom 编辑器和 nodejs npm 的命令行两个平台工作,两个平台的工作相互独立,但所创建的文库却可以相互共用
(PS:对这两个平台的依赖都是编辑需求而不是服务器需求,amWiki 创建的文库是纯静态 html,可以布置到任意服务器)

作为 Atom 插件安装

  1. 下载 Github 开源文本编辑器 Atom,并安装
  2. 安装 Atom 插件 amWiki,并在完成后重启 Atom
    • 前往 Github 的 amWiki版本发布页 下载最新版压缩包,解压到 C:\\Users\\Administrator.atom\\packages,并将文件夹名 amWiki-1.x.x 改为 amWiki
    • 或者,Atom 菜单,File -> Setting -> Install-> 搜索 amWiki -> 找到 amWikiInstall
    • 或者,在 cmd 或终端中命令:apm install amWiki(_第三字母 W 大写_)
  3. 在 Atom 菜单,File -> Add Project Folder 添加一个项目文件夹
  4. 在此文件夹下创建一个名为 config.json 的文件
  5. 在 Atom 菜单,amWiki轻文库 -> 通过config.json创建新文库

作为 nodejs 全局模块安装

  1. 下载 nodejs 并安装
  2. 执行命令: npm install -g amwiki(_第三字母 w 小写_)
  3. cd 到某个文件夹,通过命令 amwiki create 创建文库
  4. 通过命令 amwiki help 查看帮助

amWiki 文档 & 案例

更多详细功能与使用介绍请前往:
amWiki 官网文档中心
(amWiki 的文档由项目自身创建与维护)

给我留言

Copyright © 西狂部落阁 保留所有权利.   Theme  Ality 京ICP备16034339号

用户登录

分享到: