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