Gitit Bigger: 最好的個人Wiki/文檔方案（Git、Markdown、Bootstra

Yi_Zhi_Yu 發布于2019-06-28 14:59 / 1482人閱讀

摘要：基于和的超棒的系統，編輯器等增強，支持部署。背景的倉庫只有提交到倉庫里的文件，才會被添加到中。除外，我也運行了另外的實例來做私人筆記。在服務端時，可考慮使用做反向代理，為每個實例綁定一個二級域名。在本地時，可以用和一類的來處理域問題。

Gitit Bigger

Gitit Bigger: Git and Markdown based wiki, Bootstrap, ace Editor, syntax highlight and docker deploy support.

基于 Git 和 Markdown 的超棒的 Wiki 系統，Bootstrap、Ace 編輯器等增強，支持 Docker 部署。

開始 Start Bigger

假定你已安裝 Git 和 Gitit

普通版

git clone https://github.com/shajiquan/gitit-bigger ~/workspace/gitit;
cd ~/workspace/gitit;
cp sample.gitit.conf my-gitit.conf;
./run/run.sh start;

Docker 版

docker run -d --name gitit -p 7500:7500 shajiquan/gitit;

訪問：http://127.0.0.1:7500

Demo & Screeenshots Demos

Gitit Bigger：http://wiki.shajiquan.com/gitit-bigger (Read Only)

Gitit 官方：http://gitit.net

截圖 Screenshots 查看 View

view.png

view-ipad-mini.png

view-iphone6.png

編輯 Edit

edit.png

edit-ipad-mini.png

edit-iphone6.png

Gitit 主要特性

無數據庫

Git 版本控制

Markdown 格式

Wiki 化：

子目錄，無限目錄（這也是我拋棄其他一些類似 wiki 系統的原因）

中文目錄、中文標題、中文分類

完美支持中文搜索

支持分類

支持自定義標題

代碼高亮

支持公式等（我基本不用）

導出 epub 等（基于 pandoc）

更多關于 Gitit 的安裝、部署、優化的中文介紹和說明，請見:

gitit_base.md 簡介、安裝、部署

gitit_config.md 配置

Gitit Bigger VS Gitit

Bootstrap 模板

Ace Editor

Ace Editor 的編輯模式已設為 markdown。

支持代碼高亮

搜索、替換（cmd+option+f）

Tab 縮進、恢復（tab、shift+tab）

快捷鍵

...

采用配置文件方式啟動，多個實例輕松共享資源

支持自定義 Ace 編輯器啟用/禁用、模式、樣式等配置

支持 Markdown 模式下快捷鍵

數學公式：支持 MathJax 啟用/禁用，自定義 MathJax 源

代碼高亮：支持使用 highlight.js 高亮代碼 - Gitit 的高亮需要服務端支持

增加啟動、部分、自動備份腳本或幫助

注意：wikidata 倉庫

請注意檢查你的 wikidata/ 目錄的 git 配置。請注意：

wikidata 文件夾是一個本地倉庫，所有的 wiki 頁面都將保存到此處；

Gitit 啟動時，會檢查這個文件夾是否存在，如果不存在，Gitit 將會創建它，并初始化它為一個本地倉庫

只有提交到倉庫里的文件，才會被 Gitit 添加到 wiki 中。

如果你想要將此倉庫與你的遠程倉庫綁定、同步：你需要：

clone 你的 wiki 倉庫到 wikidata 文件夾：git clone your-wikidata.git ./wikidata，或者：

運行 git remote 相關命令，使 wikidata 文件夾和你的遠程倉庫連接起來；

# 如果  wikidata 文件夾尚不存在
cd ~/workspace/gitit
git clone your-wikidata.git ./wikidata
git branch --set-upstream-to=origin/master master
# 啟動 gitit 服務: ./run/run.sh start

# 如果 wikidata 已經存在，但并沒有和你的遠程倉庫綁定
cd wikidata
git remote add origin path/to/your-wikidata.git
git branch --set-upstream-to=origin/master master
# 啟動 gitit 服務: ./run/run.sh start

配置、自定義 JS/CSS

Gitit Bigger 提供一定程度的配置。

你可以通過在 templates/page_more_scripts.st 里定義 BIGGER_SETTINGS_APPEND 對象來覆蓋默認配置。

包括：

ace 編輯器

markdown

MathJax 數學公式插件

highlightjs 代碼高亮

Google Analytics 統計

詳情見：gitit_bigger_config.md

工具 Utils

啟動控制

批量修改擴展名

自動備份輔助

詳情見：- gitit_bigger_utils.md

通過 Shell 編輯 wiki

不通過 web界面，也可以操作我們的 Gitit Wiki。背景：

wikidata: wiki pages 的倉庫

只有提交到倉庫里的文件，才會被 Gitit 添加到 wiki 中。

# 進入 wikidata 目錄
cd /path/to/your/wikidata

# 新增文件并輸入一些字符串
touch new_page.md
echo "hello shajiquan" >> new_page.md

# 添加新文件到倉庫
git add new_pge.md
git commit -m "add new_page.md file"

# 更新文件并提交到倉庫
echo "new line" >> old_page.md
git add old_page.md
git commit -m "update old_page.md "

# 推送到遠程倉庫
git push origin master

多個實例

通過配置文件的方式，可以輕松運行多個 Gitit 實例。除 wiki.shajiquan.com 外，我也運行了另外的實例來做私人筆記。

cp sample.gitit.conf my-gitit-private.conf;

更新 my-gitit-private.conf 里的相關配置，尤其是：端口、wikidata 目錄（詳見gitit_config.md 配置）

啟動新實例：gitit -f my-gitit-private.conf

注意

如果 my-gitit.conf 和 my-gitit-private.conf 這兩個實例使用不同的用戶，可能會造成 cookies 的混亂。

在服務端時，可考慮使用 nginx 做反向代理，為每個實例綁定一個二級域名。

在本地時，可以用 localhost 和 127.0.0.1 一類的來處理 cookie 域問題。

Docs

Gitit 簡介、安裝、部署

Gitit 配置項介紹

Gitit-Bigger-Docker 版介紹

Gitit-Bigger 定制說明

Gitit-Bigger 工具.md

反饋、建議、聯系

Github Issues：https://github.com/shajiquan/gitit-bigger/issues

Email: shajiquan@gmail.com

QQ: 2848559858

ChangeLog v0.1.2

對內容區的圖片做了響應式處理，不會再撐爛頁面

v0.1.1

重寫文檔

增加一些小配置項

v0.1beta

新增配置方式；

修復 MathJax JS 文件引入錯誤；

v0.0.0.1

初步實現，整合 ace、markdown、highlightjs 等

Links

Github：https://github.com/shajiquan/gitit-bigger

DockreHub：https://hub.docker.com/r/shajiquan/gitit

Demo: http://wiki.shajiquan.com/gitit-bigger (Read Only)

gitit official site: http://gitit.net

gitit official github: https://github.com/jgm/gitit

在Archlinux上部署gitit Wiki: http://www.360doc.com/content/12/0518/21/21412_211977928.shtml

Gitit - git based wiki: http://walkingice.blogspot.hk/2011/11/gitit-git-based-wiki.html

Hyzual/docker-gitit: https://github.com/Hyzual/docker-gitit

Gitit Bootstrap 模板：Changaco/gitit-bootstrap

Gitit ace editor 支持 Getting the Ace editor to work with gitit

云服務器 GPU云服務器個人wiki之殤支持markdown的博客基于php的wiki git服務器備份方案

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/26447.html

使用 Hexo 創建項目文檔網站

摘要：而且通常來說，是用來介紹項目，而不是展示文檔。如果不確定系統中是否已經安裝了，使用下面的命令檢查如果出現了的版本號，則不需要再安裝了。例如我執行的命令如下然后使用進入項目目錄，并創建一個名為的目錄目錄將存放我們的文檔。當我們發布一個開源項目的時候，最重要的事情之一就是要創建項目文檔。對使用項目的用戶來說，文檔是非常有必要的，通常我們可以使用下面這些方式來創建文檔： GitHub W...

mikasa 2019-08-01 17:05 評論0 收藏0
【效率專精系列】善用API統一描述語言提升RestAPI開發效率

摘要：其標準為前身是，提供強大的在線編輯功能，包括語法高亮錯誤提示自動完成實時預覽，并且支持用戶以格式撰寫導入導出轉換文檔。團隊內部RestAPI開發采用設計驅動開發的模式，即使用API設計文檔解耦前端和后端的開發過程，雙方只在聯調與測試時耦合。在實際開發和與前端合作的過程中，受限于眾多因素的影響，開發效率還有進一步提高的空間。本文的目的是優化工具鏈支持，減少一部分重復和枯燥的勞動。現狀...

tianyu 2019-08-16 10:42 評論0 收藏0
Welcome to the api-doc wiki!

摘要：初衷原因很簡單，最主要是簡化接口文檔的編寫對接口的修改更加快速的可見主要作用主要功能是生成文檔它拓展了標準注釋，無需使用注解，減少了入侵。使用類加載主要是為了，更加準確對源碼進行解析利用反射。更多持久化方案，如等支持 Welcome to the api-doc wiki! showImg(https://raw.githubusercontent.com/hsjfans/git_re...

smartlion 2019-08-16 18:00 評論0 收藏0
api 接口管理工具

摘要：接口管理工具大致分為線上工具和自建工具。安裝其他工具上面講的，不管是線上工具還是自建工具，都是接口集成工具，主要是為了提供數據功能。類似網易云筆記印象筆記的筆記管理工具。 api 接口管理工具現在，Web 應用的前后端分離事實上已經成為了大家都認可的一種開發方式，前后端分離之后，前端與后端都用接口（api）來溝通，這就需要我們做好 API 接口管理，所以，這次來聊聊 API 接口管理...

marser 2019-08-23 14:43 評論0 收藏0
api 接口管理工具

摘要：接口管理工具大致分為線上工具和自建工具。安裝其他工具上面講的，不管是線上工具還是自建工具，都是接口集成工具，主要是為了提供數據功能。類似網易云筆記印象筆記的筆記管理工具。 api 接口管理工具現在，Web 應用的前后端分離事實上已經成為了大家都認可的一種開發方式，前后端分離之后，前端與后端都用接口（api）來溝通，這就需要我們做好 API 接口管理，所以，這次來聊聊 API 接口管理...

wuyumin 2019-08-16 14:27 評論0 收藏0