amWiki 轻文库

amWiki A lightweighted document system developed by Javascript, running as a plugin inside Atom editor, allowing you write your documents with pure Markdown script in simple text. amWiki Dedicated to make your doucments easier and agile, a perfect documenting tool for both personal and team.

Reference:
amWiki Github Repo

amWiki Pros

• Write you document in pure text markdown.
• No database，All documents are in .md format.
• No server side development，only need static http access
• One click to generate a demo library
• Auto generate and update document index
• Support screenshot saved as png and insert to current editing document.
• Adaptive design for html style, seamlessly running on all platforms.
• Support API document remote fetching, and generating simple ajax test cases.
• ... (More need you to discover)

web demo templated

One click to generate a template document website：https://tevinli.github.io/amWiki/

How to start

1. Download and install Atom editor Atom Site

2. Install amWiki as an Atom plugin, then Restart Atom

   • Atom Menu，File -> Setting -> Install -> search amWiki
   • Or，run cmd：apm install amWiki
   • Or，go to Github Repo amWiki Release download as zip，extract to C:\Users\Administrator\.atom\packages，then rename folder name amWiki-masterto amWiki

3. Create a local folder for the new document library.

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文库 -> 提取h2、h3标题为页内目录 注意：请按顺序使用h1、h2、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。
个人开源不易，欢迎来github上star支持一下，如果发现问题或好的建议，请尽量在github上发issues，不胜感谢！

更新日志

如何获取最新版本信息与动态？

• 欢迎添加作者微信为好友，微信号 XF90_Net
  (大家加微信的时候都尽量备注一下原因吧，没有备注的不加哦！目前主要集中精力在开发，暂不接受各种调戏跟闲聊～)
• 其他途径： QQ群347125653 / 微博 / Twitter

如何查看历史版本日志？

amWiki 版本更新日志