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

Yi_Zhi_Yu 发布于2019-06-28 14:59 / 1410人阅读

摘要：基于和的超棒的系统，编辑器等增强，支持部署。背景的仓库只有提交到仓库里的文件，才会被添加到中。除外，我也运行了另外的实例来做私人笔记。在服务端时，可考虑使用做反向代理，为每个实例绑定一个二级域名。在本地时，可以用和一类的来处理域问题。

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服务器备份方案

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/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