An open API service indexing awesome lists of open source software.

https://github.com/glvis/web

GLVis website
https://github.com/glvis/web

Last synced: 3 months ago
JSON representation

GLVis website

Awesome Lists containing this project

README

          

# GLVis / web

This repo contains the GLVis website [MkDocs](http://www.mkdocs.org/) sources.

To clone, including submodules

```
git clone --recurse-submodules git@github.com:GLVis/web.git
```

If you've already cloned you can pull submodules with:

```
git submodule update --init --recursive
```

To make changes to the website you will need an install of Python 3 with the following libraries:

- use MkDocs v1.0.4 with Markdown v3.0 and the latest PyYAML
* `pip install --upgrade --user mkdocs==1.0.4`
* `pip install --upgrade --user Markdown==3.0`
* `pip install --upgrade --user PyYAML`
- newer versions may not generate correct front page (to see the installed version, use `pip show mkdocs`)
- clone this repo,
- edit or add some `.md` files (you may also need to update the `mkdocs.yml` config),
- preview locally with `mkdocs serve` (Windows users may need to specify a port, such as `mkdocs serve --dev-addr 127.0.0.1:4000`),
- publish with `mkdocs gh-deploy`.