新一批文档资源文件添加
This commit is contained in:
TevinLi
parent
e2bf387a9b
commit
97fc32deca
|
|
@ -0,0 +1,51 @@
|
|||
# 如何编辑 amWiki 轻文库
|
||||
|
||||
文库创建后，您就可以编辑自己的文库了
|
||||
|
||||
## 基本编辑
|
||||
|
||||
1. ##### 新建文件或文件夹，组织您自己的文库
|
||||
|
||||
|
||||
2. ##### 每个文件夹或文件要求使用 `id-名称.md` 来命名，其中：
|
||||
|
||||
1. id 仅允许 **整数** 或 **浮点数** 类型，且 **不可重复**
|
||||
2. 必须使用连 **接符** 或 **下划线** 将 id 与后续具体名称相连
|
||||
3. 文件只能使用 **.md** 扩展名
|
||||
|
||||
如果未能满足以上条件，将弹出以下错误提示：
|
||||
|
||||
|
||||
|
||||
正确的命名，例如：
|
||||
|
||||
|
||||
3. ##### 使用 Markdown 语法编辑您的文档
|
||||
|
||||
|
||||
## 扩展编辑
|
||||
|
||||
1. ##### library 文件夹下 `首页.md` 文档为默认打开时的显示内容
|
||||
您可以适当修改此文档内容以符合您的项目需求
|
||||
|
||||
5. ##### `$navigation.md` 导航文件无需人工维护，创建新文件夹或文件时将自动更新，也可以在菜单栏手动刷新：
|
||||
|
||||
菜单栏 -> amWiki文库 -> 手动更新当前文库导航文件
|
||||
|
||||
|
||||
6. ##### 如果需要在 Markdown 文档中插入图片，**请先截图**，然后在文档对应位置使用快捷键：`Ctrl + Shift + V`
|
||||
|
||||
7. ##### 对于较长文章，可以使用页内目录，依次进行如下操作，或使用快捷键 `Ctrl + D`，即可在光标处插入页内目录。
|
||||
菜单栏 -> amWiki文库 -> 提取h2、h3标题为页内目录
|
||||
|
||||
注意：请按顺序使用h1、h2、h3，且h1仅使用一次。
|
||||
|
||||
8. ##### 如果启用了测试模块，想对一篇文档激活接口测试功能，请参照 [使用测试模块测试接口](?file=001-学习amWiki/06-使用测试模块测试接口)
|
||||
|
||||
|
||||
## 维护与延伸
|
||||
|
||||
1. 本插件升级后，您想更新 `(projectName)/amWiki/` 文件夹下 web 端的工作文件，您只需重新打开 `config.json` 文件，然后在 Atom 菜单上选择 `通过“config.json”创建新文库` 即可。
|
||||
这个二次创建操作不会影响您 library 与 assetes 文件夹下的内容。
|
||||
|
||||
2. 借助版本管理 SVN、Git、Hg，传输协议FTP/SFTP，文件同步Dropbox、百度云等等工具，便捷实现网络访问。
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# amWiki 轻文库简介
|
||||
|
||||
|
||||
amWiki 是一款基于 Javascript 脚本语言、依赖 Atom 编辑器、使用 Markdown 标记语法的轻量级开源 wiki 文库系统。
|
||||
amWiki 致力于让大家可以更简单、更便捷的建设个人和团队文库系统！
|
||||
|
||||
**传送门**
|
||||
[amWiki 项目 Github 托管地址](https://github.com/TevinLi/amWiki "amWiki项目Github托管地址")
|
||||
[ ](https://github.com/TevinLi/amWiki)
|
||||
|
||||
## amWiki 优势
|
||||
- 文档系统采用 Markdown 语法 [>>Markdown 快速开始](?file=001-学习amWiki/11-Markdown快速开始)
|
||||
- 无需服务端开发，只需支持 http 访问的静态网页空间
|
||||
- 不使用数据库，使用 `.md` 扩展名存储文档为本地文件
|
||||
- 一键创建新文库，自动生成一套 Html 页面
|
||||
- 自动更新文库导航目录
|
||||
- 支持截图直接粘帖为本地 png 并插入当前 Markdown 文档
|
||||
- Web 端页面自适应显示，适合各种 Web 平台与屏幕尺寸
|
||||
- 支持接口文档自动抓取内容生成简单的 Ajax 测试
|
||||
- ... (更多内容期待您的发现)
|
||||
|
||||
## 效果演示
|
||||
**Web端**
|
||||
一键创建新文库默认生成Web端效果一览：[http://tevinli.github.io/amWiki/](http://tevinli.github.io/amWiki/index.html)
|
||||
|
||||
**工作端**
|
||||
工作端需要您安装 Atom 与 amWiki 才能体验
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# amWiki 功能导图
|
||||
|
||||
|
||||
|
||||
**说明**：灰色文字代表的功能部分，表示目前版本没有，但是已经列入开发计划
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
# 如何开始一个新 amWiki 轻文库
|
||||
|
||||
## 开始一个新文库的步骤
|
||||
|
||||
1. ##### 下载 Github 出品的开源文本编辑器 [Atom](https://atom.io/ "打开Atom官网")，并安装
|
||||
|
||||
|
||||
2. ##### 安装 Atom 完成之后，再安装插件 amWiki，您可以通过以下三种途径安装：
|
||||
- 【方式一】：通过 Atom 菜单，File -> Setting -> Install -> 搜索 `amWiki`
|
||||
|
||||
<br>
|
||||
- 【方式二】：运行：`apm install amWiki`
|
||||
|
||||
<br>
|
||||
- 【方式三】：从Github的 [amWiki版本发布](https://github.com/TevinLi/amWiki/releases) 下载zip，(windows)解压到 `C:\Users\Administrator\.atom\packages`，并将文件夹名 `amWiki-x.x.x` 改为 `amWiki`
|
||||
|
||||
3. ##### 重启 Atom (必须)
|
||||
|
||||
4. ##### 在本地您需要创建文库的位置创建一个文件夹 (非 Atom 编辑器中)
|
||||
|
||||
5. ##### 在 Atom 中 `Add Project Folder` (添加项目文件夹)，并指向刚创建的文件夹
|
||||
|
||||
|
||||
6. ##### 在 Atom 刚创建的项目下新建 `config.json` 文件，并按 json 格式配置以下属性：
|
||||
- **name**，您的文库名称，设置但为空或不设置将显示默认名
|
||||
- **ver**，文本版本号或维护者名号，设置但为空将不显示，注意诺不设置此属性将显示 amWiki 作者
|
||||
- **logo**，logo 的 url，设置但为空或不设置将显示默认 logo
|
||||
- **colour**，自定义颜色，默认为蓝色
|
||||
- **testing**，是否启用接口测试模块，默认值 false
|
||||
- 例如：
|
||||
```javascript
|
||||
{
|
||||
"name": "A3项目文档中心",
|
||||
"ver": "",
|
||||
"logo": "http://abc.com/logo.jpg",
|
||||
"testing": true
|
||||
}
|
||||
```
|
||||
7. ##### 保持 `config.json` 处于当前打开状态，在 Atom 菜单点击：
|
||||
|
||||
amWiki文库 -> 通过“config.json”创建新文库
|
||||
|
||||
|
||||
8. ##### 此时项目中自动创建了许多内容，其中 library 文件夹即为您的文库文件夹
|
||||
|
||||
|
||||
9. ##### 使用 `F12` 启动本地静态服务器，访问刚刚自动创建的 index.html
|
||||
|
||||
|
||||
## 文库目录结构
|
||||
项目目录自动生创建的内容如下
|
||||
|
||||
index.html // http 访问入口页面
|
||||
amWiki/ // amWiki Web 端程序文件夹
|
||||
library/ // 您的 Markdown 文库目录，所有文件必须使用 .md 格式
|
||||
├ $navigation.md // amWiki 文库目录导航文件，可自动/手动更新
|
||||
├ 首页.md // Web 端打开页面时页面页面默认显示的内容
|
||||
├ 001-学习amWiki/ // Markdown 文件夹01
|
||||
│ ├ 001-关于amWiki // 一些 Markdown 文档，支持二级目录
|
||||
│ └ 002-...
|
||||
├ 002-文档示范/ // Markdown 文件夹02
|
||||
│ ├ 001-通用api // 一些 Markdown 文档，支持二级目录
|
||||
│ └ 002-...
|
||||
└ 003-... // 更多 Markdown 文件夹
|
||||
(assetes/) // 如果您粘帖截图，图片文件将自动创建在此处
|
||||
|
||||
|
||||
## 如何使用
|
||||
一键创建新文库后，您可以通过以下方式开始 amWiki 文库之旅：
|
||||
|
||||
1. 在 Atom 编辑器中使用快捷键 `F12` 或在浏览器中使用 http 访问刚刚创建的 index.html。
|
||||
2. PC 端使用左侧导航栏、移动端使用右上角弹出菜单来切换页面。
|
||||
3. 在导航栏顶部，可以使用筛选功能通过输入关键词对整个导航目录进行筛选。
|
||||
4. 如果存在页内目录，直接点击，页内目录使用 hash 滚动；同时您可以直接带 hash 分享，以方便他人快速浏览指定内容。
|
||||
Loading…
Reference in New Issue