[Doc-gitlab-com](https://gitlab.com/gitlab-com/doc-gitlab-com/) generates html pages for the [GitLab documentation website](https://docs.gitlab.com/). The documentation is generated from the markdown files in /doc directory of the GitLab repo's. The conversion from markdown into html is done with [Pandoc](http://johnmacfarlane.net/pandoc/).
[Doc-gitlab-com](https://gitlab.com/gitlab-com/doc-gitlab-com/) generates HTML
pages for the [GitLab documentation website](https://docs.gitlab.com/). The
documentation is generated from the Markdown files in the `/doc` directory of
the GitLab repos. The conversion from Markdown into HTML is done with
[Pandoc](http://johnmacfarlane.net/pandoc/).
If you want to contribute with documentation, please add them to the corresponding project:
If you want to contribute with documentation, please add them to the
And follow the [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#merge-request-guidelines) and [documentation styleguides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md) of each project.
And follow the [contributing guidelines][contributing] and
[documentation styleguide][doc-styleguide] of each project.
# Testing
## Requirements
Please replace sytse with your username.
Only 2 requirements:
```bash
ssh sytse@doc.gitlab.com
sudo su
cd /root/doc-gitlab-com && git pull && ./generate.rb no-clone && service nginx restart
```
- Ruby
- Pandoc
or to also update the repo's
No version restrictions, although you'd probably be better off using the
latest of both.
```bash
cd /root/doc-gitlab-com && git pull && ./generate.rb && service nginx restart
```
## Generation
To build the documentation website we use the `generate.rb` script which:
1. Clones the respective repositories in `/tmp/gitlab/`.
1. Uses pandoc to create HTML documents from Markdown using `template.html` as
a template.
1. Copies the stylesheets and the index page.
By default, the site is built in the `public/` directory inside the root
directory of this project. You can override this using the `SITE_PATH`
environment variable.
No console output will be created by default during the build process. If you
want to see progress indicators, set the `PROGRESS` environment variable:
# Restrictions
+ All files should be in a doc/something directory, not any deeper.
+ Only png image files are supported.
# Installation
Login as **root** and execute the following commands:
```bash
apt-get update
apt-get upgrade
apt-get remove pandoc # Pandoc 1.9.1 doesn't support pipe tables.
