Atom 编辑器插件：amWiki 轻文库

amWiki 是一款基于 Javascript 脚本语言、依赖 Atom 编辑器、使用 Markdown 标记语法的轻量级开源 wiki 文库系统。
amWiki 致力于让你们能够更简单、更便捷的建设我的和团队文库系统！

[View amWiki on Github]

GitHub:

Apm:

amWiki优点

• 文档系统采用 markdown 语法

• 无需服务端开发，只需支持 http 访问的静态网页空间

• 不使用数据库，使用 .md 扩展名存储文档为本地文件

• 一键建立新文库，自动生成一套 Html 页面

• 自动更新文库导航目录

• 支持截图直接粘帖为本地 png 并插入当前 Markdown 文档

• Web 端页面自适应显示，适合各类 Web 平台与屏幕尺寸

• 支持接口文档自动抓取内容生成简单的 Ajax 测试

• ... (更多内容期待您的发现)

web端效果演示

一键建立新文库将自动生成一套Web端html页面
默认生成效果一览：http://tevinli.github.io/amWiki/

如何开始

1. 下载Github开源文本编辑器 Atom官网 / Atom下载，并安装

2. 安装Atom插件amWiki，并重启Atom

   • Atom菜单，File -> Setting -> Install -> 搜索amWiki

   • 或者，运行cmd：apm install amWiki

   • 或者，从Github的 amWiki版本发布 下载zip，解压到C:UsersAdministrator.atompackages，并将文件夹名amWiki-master改成amWiki

3. (在本地服务器静态目录)建立一个文件夹

4. 在Atom中 添加项目文件夹，并指向刚建立的文件夹

5. 在Atom刚建立的项目下新建config.json文件，并输入一下内容：

   {
       "name": "",      //您的文库名称，设置但为空或不设置将显示默认名
       "ver": "",       //文本版本号或维护者名号，设置但为空将不显示，注意诺不设置此属性将显示amWiki做者
       "logo": "",      //logo的url，设置但为空或不设置将显示默认logo
       "testing": true, //是否启用接口测试，默认值false
       "colour": ""     //自定义颜色，默认为蓝色
   }

6. 点击Atom菜单：

   Packages -> amWiki文库 -> 经过“config.json”建立新文库

7. 此时项目中自动建立了许多内容，其中 library 文件夹即为您的文档库，编辑您的文库文档

8. 使用 F12 启动本地静态服务器，访问刚刚自动建立的 index.html

目录结构

自动生建立的内容目录以下

index.html               //http访问首页
amWiki/                  //amWiki工做文件目录
library/                 //您的markdown文库目录，全部文件必须使用.md格式
  ├ $navigation.md       //amWiki文库目录导航文件，可自动/手动更新
  ├ 首页.md              //内容区默认显示内容
  ├ 01-关于amWiki文库/    //markdown文件夹01
  │   ├ 001-关于amWiki   //一些markdown文档，支持二级目录
  │   └ 002-...
  ├ 02-学习markdown/     //markdown文件夹02
  │   ├ 001-md入门       //一些markdown文档，支持二级目录
  │   └ 002-...
  └ 03-...               //更多markdown文件夹
(assetes/)               //若是您粘帖截图，图片文件将自动建立在此处

如何编辑

1. 新建或更改文件夹和文档名，组织您本身的文档结构 (文档必须markdown文档、使用.md扩展名)

2. 编辑markdown文档，制做您本身的文档内容

3. 每一个文件夹或文件使用“id-名称”来实现命名排序，请勿删除id，删除后将没法正常工做
   id仅容许整数或浮点数类型，且使用链接符或下划线与具体名称组成命名

4. library文件夹下首页.md为打开时默认的或url参数错误时的显示内容

5. $navigation.md导航文件无需人工维护，建立新文件夹或文件时将自动更新，也能够在菜单栏手动刷新：

   菜单栏 -> amWiki文库 -> 手动更新当前文库导航文件

6. 若是须要在markdown文档中插入图片，请先截图，而后在.md文档对应位置使用快捷键：Ctrl + Shift + V

7. 对于较长文章，可使用页内目录，依次进行以下操做，或使用快捷键Ctrl + D，便可在光标处插入页内目录。

   菜单栏 -> amWiki文库 -> 提取h二、h3标题为页内目录

   注意：请按顺序使用h一、h二、h3，且h1仅使用一次。

8. 若是启用了测试，对于文档中同时存在“请求地址”“请求类型”“请求参数”三个h3标题的文档，自动在右上角激活接口测试功能

   • 请求参数的表格，请按参数名、类型、必填、描述、默认值的顺序创建表格，不然不能正常抓取

   • 只能请求同域接口，不能跨域

   • 若是接口须要登陆权限，请先登陆您本身的系统

9. 本插件升级后，您想更新项目/amWiki/文件夹下web端的工做文件，您只需从新打开config.json文件，而后在Atom菜单上选择经过“config.json”建立新文库便可。
   这个二次建立操做不会影响您 library 与 assetes 文件夹下的内容。

10. 借助版本管理 SVN、Git、Hg，传输协议FTP/SFTP，文件同步Dropbox、百度云等等工具，便捷实现网络访问。

如何使用

1. 使用 http 访问项目的 index.html。

2. PC端使用左侧导航栏、移动端使用右上角导航弹出菜单切换页面。

3. 在导航栏或导航菜单顶部，可使用 栏位对导航目录进行筛选。

4. 若是存在页内目录，直接点击，页内目录使用hash滚动；同时您能够直接带hash分享，以方便他人快速浏览指定内容。

5. 若是页面激活了接口测试功能，点击右上角“测试接口”打开测试面板，输出参数并点击“发送Ajax”，便可看到响应内容。

后记

这个项目的初始灵感来自 MDwiki，它是一个使用 html5/js 纯静态的 markdown wiki 系统。
一开始，我也准备使用它来写一些文档，可是我很快发现，若是我新增一篇文档，须要我手动去编辑导航栏文件增长一条导航，这个体验并不友好。而后想写一套相似 微信公众平台开发者文档 这样较大的文档库，发现 MDwiki 因为其容量所限，并不能很好的胜任。
因而通过一番折腾，就有了amWiki。

---

原文地址：https://github.com/TevinLi/amWiki