Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
menduo committed Apr 3, 2017
1 parent 453e4b0 commit a6a4d9c
Show file tree
Hide file tree
Showing 11 changed files with 46 additions and 46 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
@@ -1,14 +1,14 @@
## Dockerfile for gitit

FROM debian:wheezy
MAINTAINER shajiquan "shajiquan@gmail.com"
MAINTAINER menduo "shimenduo@gmail.com"

ENV DEBIAN_FRONTEND noninteractive

# install git, ssh, supervisor
RUN apt-get update && apt-get install -y git gitit supervisor libghc-zlib-dev

RUN echo "root:github.com/shajiquan" | chpasswd
RUN echo "root:github.com/menduo" | chpasswd

VOLUME ["/data/gitit"]
WORKDIR /data/gitit
Expand Down
12 changes: 6 additions & 6 deletions README.md
Expand Up @@ -18,14 +18,14 @@ cp sample.gitit.conf my-gitit.conf;
- Docker 版

```bash
docker run -d --name gitit -p 7500:7500 shajiquan/gitit;
docker run -d --name gitit -p 7500:7500 menduo/gitit-bigger;
```

访问:[http://127.0.0.1:7500](http://127.0.0.1:7500)

# Demo & Screeenshots
## Demos
- Gitit Bigger:[http://wiki.shajiquan.com/gitit-bigger](http://wiki.shajiquan.com/gitit-bigger) (Read Only)
- Gitit Bigger:[https://wiki.menduo.net/gitit-bigger](https://wiki.menduo.net/gitit-bigger) (Read Only)
- Gitit 官方:[http://gitit.net](http://gitit.net)

## 截图 Screenshots
Expand Down Expand Up @@ -131,7 +131,7 @@ cd /path/to/your/wikidata

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

# 添加新文件到仓库
git add new_pge.md
Expand All @@ -147,7 +147,7 @@ git push origin master
```

# 多个实例
通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.shajiquan.com 外,我也运行了另外的实例来做私人笔记。
通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.menduo.net 外,我也运行了另外的实例来做私人笔记。
1. `cp sample.gitit.conf my-gitit-private.conf;`
2. 更新 `my-gitit-private.conf` 里的相关配置,尤其是:端口、wikidata 目录(详见[gitit_config.md 配置](https://github.com/menduo/gitit-bigger/blob/master/docs/gitit_config.md)
3. 启动新实例:`gitit -f my-gitit-private.conf`
Expand Down Expand Up @@ -175,8 +175,8 @@ git push origin master

# Links
- Github:[https://github.com/menduo/gitit-bigger](https://github.com/menduo/gitit-bigger)
- DockreHub:[https://hub.docker.com/r/shajiquan/gitit](https://hub.docker.com/r/shajiquan/gitit)
- Demo: [http://wiki.shajiquan.com/gitit-bigger](http://wiki.shajiquan.com/gitit-bigger) (Read Only)
- DockreHub:[https://hub.docker.com/r/menduo/gitit-bigger](https://hub.docker.com/r/menduo/gitit-bigger)
- Demo: [https://wiki.menduo.net/gitit-bigger](https://wiki.menduo.net/gitit-bigger) (Read Only)
- gitit official site: [http://gitit.net](http://gitit.net)
- gitit official github: [https://github.com/jgm/gitit](https://github.com/jgm/gitit)
- 在Archlinux上部署gitit Wiki: [http://www.360doc.com/content/12/0518/21/21412_211977928.shtml](http://www.360doc.com/content/12/0518/21/21412_211977928.shtml)
Expand Down
12 changes: 6 additions & 6 deletions README.rst
Expand Up @@ -25,7 +25,7 @@ highlight and docker deploy support.

.. code:: bash
docker run -d --name gitit -p 7500:7500 shajiquan/gitit;
docker run -d --name gitit -p 7500:7500 menduo/gitit-bigger;
访问:\ http://127.0.0.1:7500

Expand All @@ -35,7 +35,7 @@ Demo & Screeenshots
Demos
-----

- Gitit Bigger:\ http://wiki.shajiquan.com/gitit-bigger (Read Only)
- Gitit Bigger:\ https://wiki.menduo.net/gitit-bigger (Read Only)
- Gitit 官方:\ http://gitit.net

截图 Screenshots
Expand Down Expand Up @@ -162,7 +162,7 @@ wiki pages 的仓库 2. 只有提交到仓库里的文件,才会被 Gitit 添
# 新增文件并输入一些字符串
touch new_page.md
echo "hello shajiquan" >> new_page.md
echo "hello menduo" >> new_page.md
# 添加新文件到仓库
git add new_pge.md
Expand All @@ -179,7 +179,7 @@ wiki pages 的仓库 2. 只有提交到仓库里的文件,才会被 Gitit 添
多个实例
========

通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.shajiquan.com
通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.menduo.net
外,我也运行了另外的实例来做私人笔记。 1.
``cp sample.gitit.conf my-gitit-private.conf;`` 2. 更新
``my-gitit-private.conf`` 里的相关配置,尤其是:端口、wikidata
Expand Down Expand Up @@ -225,8 +225,8 @@ Links
=====

- Github:\ https://github.com/menduo/gitit-bigger
- DockreHub:\ https://hub.docker.com/r/shajiquan/gitit
- Demo: http://wiki.shajiquan.com/gitit-bigger (Read Only)
- DockreHub:\ https://hub.docker.com/r/menduo/gitit-bigger
- Demo: https://wiki.menduo.net/gitit-bigger (Read Only)
- gitit official site: http://gitit.net
- gitit official github: https://github.com/jgm/gitit
- 在Archlinux上部署gitit Wiki:
Expand Down
12 changes: 6 additions & 6 deletions docs/README.md
Expand Up @@ -18,14 +18,14 @@ cp sample.gitit.conf my-gitit.conf;
- Docker 版

```bash
docker run -d --name gitit -p 7500:7500 shajiquan/gitit;
docker run -d --name gitit -p 7500:7500 menduo/gitit-bigger;
```

访问:[http://127.0.0.1:7500](http://127.0.0.1:7500)

# Demo & Screeenshots
## Demos
- Gitit Bigger:[http://wiki.shajiquan.com/gitit-bigger](http://wiki.shajiquan.com/gitit-bigger) (Read Only)
- Gitit Bigger:[http://wiki.menduo.net/gitit-bigger](http://wiki.menduo.net/gitit-bigger) (Read Only)
- Gitit 官方:[http://gitit.net](http://gitit.net)

## 截图 Screenshots
Expand Down Expand Up @@ -131,7 +131,7 @@ cd /path/to/your/wikidata

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

# 添加新文件到仓库
git add new_pge.md
Expand All @@ -147,7 +147,7 @@ git push origin master
```

# 多个实例
通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.shajiquan.com 外,我也运行了另外的实例来做私人笔记。
通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.menduo.net 外,我也运行了另外的实例来做私人笔记。
1. `cp sample.gitit.conf my-gitit-private.conf;`
2. 更新 `my-gitit-private.conf` 里的相关配置,尤其是:端口、wikidata 目录(详见[gitit_config.md 配置](https://github.com/menduo/gitit-bigger/blob/master/docs/gitit_config.md)
3. 启动新实例:`gitit -f my-gitit-private.conf`
Expand Down Expand Up @@ -175,8 +175,8 @@ git push origin master

# Links
- Github:[https://github.com/menduo/gitit-bigger](https://github.com/menduo/gitit-bigger)
- DockreHub:[https://hub.docker.com/r/shajiquan/gitit](https://hub.docker.com/r/shajiquan/gitit)
- Demo: [http://wiki.shajiquan.com/gitit-bigger](http://wiki.shajiquan.com/gitit-bigger) (Read Only)
- DockreHub:[https://hub.docker.com/r/menduo/gitit-bigger](https://hub.docker.com/r/menduo/gitit-bigger)
- Demo: [http://wiki.menduo.net/gitit-bigger](http://wiki.menduo.net/gitit-bigger) (Read Only)
- gitit official site: [http://gitit.net](http://gitit.net)
- gitit official github: [https://github.com/jgm/gitit](https://github.com/jgm/gitit)
- 在Archlinux上部署gitit Wiki: [http://www.360doc.com/content/12/0518/21/21412_211977928.shtml](http://www.360doc.com/content/12/0518/21/21412_211977928.shtml)
Expand Down
12 changes: 6 additions & 6 deletions docs/README.rst
Expand Up @@ -25,7 +25,7 @@ highlight and docker deploy support.

.. code:: bash
docker run -d --name gitit -p 7500:7500 shajiquan/gitit;
docker run -d --name gitit -p 7500:7500 menduo/gitit-bigger;
访问:\ http://127.0.0.1:7500

Expand All @@ -35,7 +35,7 @@ Demo & Screeenshots
Demos
-----

- Gitit Bigger:\ http://wiki.shajiquan.com/gitit-bigger (Read Only)
- Gitit Bigger:\ https://wiki.menduo.net/gitit-bigger (Read Only)
- Gitit 官方:\ http://gitit.net

截图 Screenshots
Expand Down Expand Up @@ -162,7 +162,7 @@ wiki pages 的仓库 2. 只有提交到仓库里的文件,才会被 Gitit 添
# 新增文件并输入一些字符串
touch new_page.md
echo "hello shajiquan" >> new_page.md
echo "hello menduo" >> new_page.md
# 添加新文件到仓库
git add new_pge.md
Expand All @@ -179,7 +179,7 @@ wiki pages 的仓库 2. 只有提交到仓库里的文件,才会被 Gitit 添
多个实例
========

通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.shajiquan.com
通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.menduo.net
外,我也运行了另外的实例来做私人笔记。 1.
``cp sample.gitit.conf my-gitit-private.conf;`` 2. 更新
``my-gitit-private.conf`` 里的相关配置,尤其是:端口、wikidata
Expand Down Expand Up @@ -225,8 +225,8 @@ Links
=====

- Github:\ https://github.com/menduo/gitit-bigger
- DockreHub:\ https://hub.docker.com/r/shajiquan/gitit
- Demo: http://wiki.shajiquan.com/gitit-bigger (Read Only)
- DockreHub:\ https://hub.docker.com/r/menduo/gitit-bigger
- Demo: https://wiki.menduo.net/gitit-bigger (Read Only)
- gitit official site: http://gitit.net
- gitit official github: https://github.com/jgm/gitit
- 在Archlinux上部署gitit Wiki:
Expand Down
2 changes: 1 addition & 1 deletion docs/gitit_base.md
Expand Up @@ -113,4 +113,4 @@ nohup gitit -f my-gitit.conf > logs-gitit.log & echo $! > pid-my-gitit.conf.pid
├── private_wiki_page.md
```

by [shajiquan](https://github.com/shajiquan/gitit-bigger)
by [menduo](https://github.com/menduo/gitit-bigger)
6 changes: 3 additions & 3 deletions docs/gitit_bigger_docker.md
Expand Up @@ -23,14 +23,14 @@
### 不挂载已有 gitit

```bash
docker run -d --name gitit -p 7500:7500 shajiquan/gitit
docker run -d --name gitit -p 7500:7500 menduo/gitit-bigger
```

### 挂载已有 gitit
假设你的 gitit 项目在 `~/workspace/gitit` 下,将此目录挂载到 docker 容器里:

```bash
docker run -d --name gitit -p 7500:7500 -v ~/workspace/gitit:/data/gitit shajiquan/gitit
docker run -d --name gitit -p 7500:7500 -v ~/workspace/gitit:/data/gitit menduo/gitit-bigger
```

### 重启 docker 容器中的 gitit 服务
Expand Down Expand Up @@ -68,4 +68,4 @@ Gitit 服务启用时将自动创建如下目录(如果它们不存在) :



by [shajiquan](https://github.com/shajiquan/gitit-bigger)
by [menduo](https://github.com/menduo/gitit-bigger)
4 changes: 2 additions & 2 deletions docs/gitit_bigger_utils.md
Expand Up @@ -22,7 +22,7 @@

选项:

- `--d`: wiki 条目所在目录,必须使用绝对路径,如 `/home/shajiquan/gitit/wikidata`。如果不传入,脚本会将脚本所在目录当作目标目录。
- `--d`: wiki 条目所在目录,必须使用绝对路径,如 `/home/menduo/gitit/wikidata`。如果不传入,脚本会将脚本所在目录当作目标目录。
- `--f`: 原始后缀名,默认为 `page`
- `--t`: 目标后缀名,默认 `md`
- `--add``--commit``--push`:是否在更改后缀名之后进行 git 的相关操作,默认为 `True`。指定非 `True` 值时,脚本将不会执行相关的 git 操作。
Expand All @@ -34,4 +34,4 @@
- 得到类似 `* * * * * /auto-data.sh > /log-auto-data.log 2>&1 &` 命令。
- 运行 `crontab -e` 并将刚才得到的命令粘贴到底部,关闭文件即可。

by [shajiquan](https://github.com/shajiquan/gitit-bigger)
by [menduo](https://github.com/menduo/gitit-bigger)
4 changes: 2 additions & 2 deletions docs/gitit_config.md
Expand Up @@ -22,10 +22,10 @@
- `modify`: 编辑阶段。当用户要编辑、删除条目时,需要登录。
- `read`:阅读阶段。当用户需要浏览条目时,需要登录。

- `access-question`: Who is shajiquan? # 访问控制问题。
- `access-question`: Who is menduo? # 访问控制问题。
- 在创建用户时,将必须回答这个问题。答案必须是下方的 `access-question-answers` 中指定的答案,答案间使用英文逗号分隔。

- `access-question-answers`: [github.com/shajiquan](https://github.com/shajiquan), [https://github.com/shajiquan](https://github.com/shajiquan)
- `access-question-answers`: [github.com/menduo](https://github.com/menduo), [https://github.com/menduo](https://github.com/menduo)
- `default-extension`: md # 默认文件名扩展,官方默认的是 `page`,我自己的版本使用的是 `md`
- `注意`:这个只在 Gitit 0.11.x 上才有作用,这意味着,当你使用 0.10.x 时,即使配置了默认扩展为 `md`,最后创建的文件,其扩展名仍然是 `page`

Expand Down
12 changes: 6 additions & 6 deletions docs/index.rst
Expand Up @@ -25,7 +25,7 @@ highlight and docker deploy support.

.. code:: bash
docker run -d --name gitit -p 7500:7500 shajiquan/gitit;
docker run -d --name gitit -p 7500:7500 menduo/gitit-bigger;
访问:\ http://127.0.0.1:7500

Expand All @@ -35,7 +35,7 @@ Demo & Screeenshots
Demos
-----

- Gitit Bigger:\ http://wiki.shajiquan.com/gitit-bigger (Read Only)
- Gitit Bigger:\ https://wiki.menduo.net/gitit-bigger (Read Only)
- Gitit 官方:\ http://gitit.net

截图 Screenshots
Expand Down Expand Up @@ -162,7 +162,7 @@ wiki pages 的仓库 2. 只有提交到仓库里的文件,才会被 Gitit 添
# 新增文件并输入一些字符串
touch new_page.md
echo "hello shajiquan" >> new_page.md
echo "hello menduo" >> new_page.md
# 添加新文件到仓库
git add new_pge.md
Expand All @@ -179,7 +179,7 @@ wiki pages 的仓库 2. 只有提交到仓库里的文件,才会被 Gitit 添
多个实例
========

通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.shajiquan.com
通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.menduo.net
外,我也运行了另外的实例来做私人笔记。 1.
``cp sample.gitit.conf my-gitit-private.conf;`` 2. 更新
``my-gitit-private.conf`` 里的相关配置,尤其是:端口、wikidata
Expand Down Expand Up @@ -225,8 +225,8 @@ Links
=====

- Github:\ https://github.com/menduo/gitit-bigger
- DockreHub:\ https://hub.docker.com/r/shajiquan/gitit
- Demo: http://wiki.shajiquan.com/gitit-bigger (Read Only)
- DockreHub:\ https://hub.docker.com/r/menduo/gitit-bigger
- Demo: https://wiki.menduo.net/gitit-bigger (Read Only)
- gitit official site: http://gitit.net
- gitit official github: https://github.com/jgm/gitit
- 在Archlinux上部署gitit Wiki:
Expand Down
12 changes: 6 additions & 6 deletions index.rst
Expand Up @@ -25,7 +25,7 @@ highlight and docker deploy support.

.. code:: bash
docker run -d --name gitit -p 7500:7500 shajiquan/gitit;
docker run -d --name gitit -p 7500:7500 menduo/gitit-bigger;
访问:\ http://127.0.0.1:7500

Expand All @@ -35,7 +35,7 @@ Demo & Screeenshots
Demos
-----

- Gitit Bigger:\ http://wiki.shajiquan.com/gitit-bigger (Read Only)
- Gitit Bigger:\ https://wiki.menduo.net/gitit-bigger (Read Only)
- Gitit 官方:\ http://gitit.net

截图 Screenshots
Expand Down Expand Up @@ -162,7 +162,7 @@ wiki pages 的仓库 2. 只有提交到仓库里的文件,才会被 Gitit 添
# 新增文件并输入一些字符串
touch new_page.md
echo "hello shajiquan" >> new_page.md
echo "hello menduo" >> new_page.md
# 添加新文件到仓库
git add new_pge.md
Expand All @@ -179,7 +179,7 @@ wiki pages 的仓库 2. 只有提交到仓库里的文件,才会被 Gitit 添
多个实例
========

通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.shajiquan.com
通过配置文件的方式,可以轻松运行多个 Gitit 实例。除 wiki.menduo.net
外,我也运行了另外的实例来做私人笔记。 1.
``cp sample.gitit.conf my-gitit-private.conf;`` 2. 更新
``my-gitit-private.conf`` 里的相关配置,尤其是:端口、wikidata
Expand Down Expand Up @@ -225,8 +225,8 @@ Links
=====

- Github:\ https://github.com/menduo/gitit-bigger
- DockreHub:\ https://hub.docker.com/r/shajiquan/gitit
- Demo: http://wiki.shajiquan.com/gitit-bigger (Read Only)
- DockreHub:\ https://hub.docker.com/r/menduo/gitit-bigger
- Demo: https://wiki.menduo.net/gitit-bigger (Read Only)
- gitit official site: http://gitit.net
- gitit official github: https://github.com/jgm/gitit
- 在Archlinux上部署gitit Wiki:
Expand Down

0 comments on commit a6a4d9c

Please sign in to comment.