Gitit Bigger: 最好的我的Wiki/文檔方案（Git、Markdown、Bootstrap、Ace、Docker）

時間 2019-11-08

標籤 gitit bigger 最好我的 wiki 文檔方案 git markdown bootstrap ace docker 欄目 Git 简体版

原文原文鏈接

Gitit Bigger

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

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

開始 Start Bigger

假定你已安裝 Git 和 Gititnginx

普通版git

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 版github

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

訪問：http://127.0.0.1:7500web

Demo & Screeenshots

Demos

Gitit Bigger：http://wiki.shajiquan.com/gitit-bigger (Read Only)docker
Gitit 官方：http://gitit.net數據庫

截圖 Screenshots

查看 View

編輯 Edit

Gitit 主要特性

無數據庫
Git 版本控制
Markdown 格式
Wiki 化：
- 子目錄，無限目錄（這也是我拋棄其餘一些相似 wiki 系統的緣由）
- 中文目錄、中文標題、中文分類
- 完美支持中文搜索
- 支持分類
- 支持自定義標題
代碼高亮
支持公式等（我基本不用）
導出 epub 等（基於 pandoc）

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

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

反饋、建議、聯繫

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 等