https://github.com/gig/open
GiG Open is an initiative from GiG to contribute back to the community. Here at GiG, we rely a lot on open technologies so this is our way to give back; both software and knowledge.
https://github.com/gig/open
mkdocs open-source policy
Last synced: about 2 months ago
JSON representation
GiG Open is an initiative from GiG to contribute back to the community. Here at GiG, we rely a lot on open technologies so this is our way to give back; both software and knowledge.
- Host: GitHub
- URL: https://github.com/gig/open
- Owner: GiG
- License: mit
- Created: 2020-06-16T09:07:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-02-27T05:25:27.000Z (4 months ago)
- Last Synced: 2026-02-27T12:59:05.732Z (4 months ago)
- Topics: mkdocs, open-source, policy
- Language: HTML
- Homepage: https://open.gig.com/
- Size: 8.87 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/GiG/open/actions?query=workflow%3A%22GitHub+Pages%22) [](https://github.com/GiG/open/discussions)
# GiG Open
This is the repository for the static documentation site for [the open.gig.com microsite](https://open.gig.com/).
## Building the site
This project is based on [MkDocs](https://www.mkdocs.org/) using the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme. To build this project you'll need Python installed on your system, the Python package manager, `pip` as well as the `mkdocs` package. You can check if you have these already installed from the command line:
```sh
$ python --version
Python 3.8.2
$ pip --version
pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8)
$ mkdocs --version
mkdocs, version 0.15.3
```
MkDocs supports Python versions 3.5, 3.6, 3.7, 3.8, and pypy3. If these are not installed, you can follow the [MkDocs installation documentation](https://www.mkdocs.org/#installation).
MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it. Make sure you're in the same directory as the `mkdocs.yml` configuration file, and then start the server by running the mkdocs serve command:
```sh
$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 160402 15:50:43 server:271] Serving on http://127.0.0.1:8000
[I 160402 15:50:43 handlers:58] Start watching changes
[I 160402 15:50:43 handlers:60] Start detecting changes
Open up http://127.0.0.1:8000/ in your browser
```
## Run Development Server with Docker
First you need to build the image:
```sh
docker build . -t gig-open
```
Once the image is built, you can run the development server by mapping the MkDocs port and mounting your source volume to `/src` as follows:
### Windows
```cmd
docker run --rm -it -v "%cd%":/src -p 8000:8000 gig-open
```
### Linux
```sh
docker run --rm -it -v ${PWD}:/src -p 8000:8000 gig-open
```