文案更新
This commit is contained in:
TevinLi
parent
6e9acccf68
commit
f2b31fa2cf
61
README.md
61
README.md
|
|
@ -1,16 +1,19 @@
|
|||
# amWiki 文库
|
||||
|
||||
amWiki是一款基于atom编辑器markdown语法的轻量级wiki文库系统。
|
||||
使用amWiki，您无需服务端开发，只需使用atom编辑markdown文档和支持http静态访问网页空间！
|
||||
传送门：[amWiki项目托管地址](https://github.com/TevinLi/amWiki "amWiki项目托管地址")
|
||||
amWiki 是一款基于 Atom 编辑器 Markdown 语法的轻量级 wiki 文库系统。
|
||||
使用 amWiki，您无需服务端开发，只需使用 Atom 编辑 Markdown 文档和支持 http 静态访问网页空间！
|
||||
|
||||
**传送门:**
|
||||
[amWiki 项目 Github 托管地址](https://github.com/TevinLi/amWiki "amWiki项目Github托管地址")
|
||||
[ ](https://github.com/TevinLi/amWiki)
|
||||
|
||||
### amWiki优势
|
||||
- 文档系统采用markdown语法
|
||||
- 不用数据库，文档使用`.md`格式保存本地文件
|
||||
- 无需服务端开发，只需支持http静态访问网页空间
|
||||
- 文档系统采用 markdown 语法
|
||||
- 不用数据库，文档使用 `.md` 格式保存本地文件
|
||||
- 无需服务端开发，只需支持 http 静态访问网页空间
|
||||
- 一键创建新的文库
|
||||
- 自动更新文库导航目录
|
||||
- 支持截图直接粘帖为本地png并插入当前markdown
|
||||
- 支持截图直接粘帖为本地 png 并插入当前 markdown
|
||||
- 文档web端自适应显示，适合所有平台
|
||||
- 支持接口文档自动抓取内容生成简单的ajax测试
|
||||
- ... (更多内容期待您的发现)
|
||||
|
|
@ -20,12 +23,12 @@ amWiki是一款基于atom编辑器markdown语法的轻量级wiki文库系统。
|
|||
|
||||
## 如何开始
|
||||
|
||||
1. 下载Github开源文本编辑器 [Atom官网](https://atom.io/ "atom官网") / [Atom下载](https://atom.io/download/windows)，并安装
|
||||
1. 下载Github开源文本编辑器 [Atom 官网](https://atom.io/ "Atom官网")，并安装
|
||||
|
||||
2. 安装Atom插件amWiki，并重启Atom
|
||||
- Atom菜单，File -> Setting -> Install -> 搜索`amWiki`
|
||||
- 或者，运行cmd：`apm install amWiki`
|
||||
- 或者，从Github的 [amWiki版本发布](https://github.com/TevinLi/amWiki/releases) 下载zip，解压到`C:\Users\Administrator\.atom\packages`，并将文件夹名`amWiki-master`改为`amWiki`
|
||||
- Atom菜单，File -> Setting -> Install -> 搜索`amWiki`
|
||||
- 或者，运行cmd：`apm install amWiki`
|
||||
- 或者，从Github的 [amWiki版本发布](https://github.com/TevinLi/amWiki/releases) 下载zip，解压到`C:\Users\Administrator\.atom\packages`，并将文件夹名`amWiki-master`改为`amWiki`
|
||||
|
||||
3. (在本地服务器静态目录)创建一个文件夹
|
||||
|
||||
|
|
@ -43,7 +46,7 @@ amWiki是一款基于atom编辑器markdown语法的轻量级wiki文库系统。
|
|||
```
|
||||
6. 点击Atom菜单：
|
||||
|
||||
Packages -> amWiki文库 -> 通过“config.json”创建新文库
|
||||
Packages -> amWiki文库 -> 通过“config.json”创建新文库
|
||||
|
||||
7. 此时项目中自动创建了许多内容，其中 library 文件夹即为您的文档库，编辑您的文库文档
|
||||
|
||||
|
|
@ -53,19 +56,19 @@ amWiki是一款基于atom编辑器markdown语法的轻量级wiki文库系统。
|
|||
## 目录结构
|
||||
自动生创建的内容目录如下
|
||||
|
||||
index.html //http访问首页
|
||||
amWiki/ //amWiki工作文件目录
|
||||
library/ //您的markdown文库目录，所有文件必须使用.md格式
|
||||
├ $navigation.md //amWiki文库目录导航文件，可自动/手动更新
|
||||
├ 首页.md //内容区默认显示内容
|
||||
├ 01-关于amWiki文库/ //markdown文件夹01
|
||||
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/) //如果您粘帖截图，图片文件将自动创建在此处
|
||||
(assetes/) //如果您粘帖截图，图片文件将自动创建在此处
|
||||
|
||||
|
||||
## 如何编辑
|
||||
|
|
@ -80,7 +83,7 @@ amWiki是一款基于atom编辑器markdown语法的轻量级wiki文库系统。
|
|||
|
||||
5. `$navigation.md`导航文件无需人工维护，创建新文件夹或文件时将自动更新，也可以在菜单栏手动刷新：
|
||||
|
||||
菜单栏 -> amWiki文库 -> 手动更新当前文库导航文件
|
||||
菜单栏 -> amWiki文库 -> 手动更新当前文库导航文件
|
||||
|
||||
6. 如果需要在markdown文档中插入图片，**请先截图**，然后在.md文档对应位置使用快捷键：`Ctrl + Shift + V`
|
||||
|
||||
|
|
@ -89,9 +92,9 @@ amWiki是一款基于atom编辑器markdown语法的轻量级wiki文库系统。
|
|||
注意：请按顺序使用h1、h2、h3，且h1仅使用一次。
|
||||
|
||||
8. 如果启用了测试，对于文档中**同时存在“请求地址”“请求类型”“请求参数”三个h3标题**的文档，自动在右上角激活接口测试功能
|
||||
- 请求参数的表格，请按`参数名、类型、必填、描述、默认值`的顺序建立表格，否则不能正常抓取
|
||||
- 只能请求同域接口，不能跨域
|
||||
- 如果接口需要登录权限，请先登录您自己的系统
|
||||
- 请求参数的表格，请按`参数名、类型、必填、描述、默认值`的顺序建立表格，否则不能正常抓取
|
||||
- 只能请求同域接口，不能跨域
|
||||
- 如果接口需要登录权限，请先登录您自己的系统
|
||||
|
||||
|
||||
9. 本插件升级后，您想更新`项目/amWiki/`文件夹下web端的工作文件，您只需重新打开`config.json`文件，然后在Atom菜单上选择`通过“config.json”创建新文库`即可。
|
||||
|
|
@ -114,21 +117,17 @@ amWiki是一款基于atom编辑器markdown语法的轻量级wiki文库系统。
|
|||
|
||||
|
||||
## 后记
|
||||
这个项目的初始灵感来自 MDwiki，它是一个使用 html5/js 纯静态的 markdown wiki 系统。
|
||||
这个项目的初始灵感来自 MDwiki，这是一个使用 html5/js 纯静态的 markdown wiki 系统。
|
||||
一开始，我也准备使用它来写一些文档，但是我很快发现，如果我新增一篇文档，需要我手动去编辑导航栏文件增加一条导航，这个体验并不友好。然后想写一套类似 [微信公众平台开发者文档](http://mp.weixin.qq.com/wiki/home/index.html) 这样较大的文档库，发现 MDwiki 由于其容量所限，并不能很好的胜任。
|
||||
于是经过一番折腾，就有了amWiki。
|
||||
个人开源不易，欢迎来github上star支持一下，如果发现问题或好的建议，请尽量在github上发issues，不胜感谢！
|
||||
|
||||
## 更新日志
|
||||
### 如何即时获取最新版本信息与动态？
|
||||
- 如果您是微信用户，欢迎加作者微信为好友，微信号 **XF90_Net**，您也可以通过扫码添加
|
||||
### 如何获取最新版本信息与动态？
|
||||
- 欢迎添加作者微信为好友，微信号 **XF90_Net**，您也可以通过扫码添加
|
||||
_(大家加微信的时候都尽量备注一下原因吧，没有备注的，不加！目前主要集中精力在开发，暂不接受各种调戏跟闲聊～)_
|
||||
|
||||
- 如果您是微博用户，您也可以关注 [微博](http://weibo.com/1706602953/profile?is_all=1) / [twitter](https://twitter.com/tevinli2009)
|
||||
- 如果您只用QQ，请加QQ交流群`347125653`
|
||||
- 其他途径： [微博](http://weibo.com/1706602953/profile?is_all=1) / [Twitter](https://twitter.com/tevinli2009) / QQ群`347125653`
|
||||
|
||||
### 如何查看历史版本日志？
|
||||
[amWiki 版本更新日志](https://github.com/TevinLi/amWiki/blob/master/CHANGELOG.md "amWiki版本更新日志")
|
||||
|
||||
## 其他
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue