5
0
Fork
You've already forked docs.eduvpn.org
0
eduVPN Server Documentation Site https://docs.eduvpn.org/
  • CSS 82.3%
  • Shell 8.9%
  • HTML 8.8%
2026年04月10日 19:10:43 +02:00
eduvpn_theme update simple.css 2026年04月10日 19:10:43 +02:00
eduvpn_theme_eol mark 2.x documentation as EOL 2024年11月19日 14:42:52 +01:00
.gitignore cleanups 2023年09月14日 23:52:33 +02:00
build.sh no longer build v2 docs, add link to commit history 2025年10月01日 14:25:44 +02:00
mkdocs.v2.yml mark 2.x documentation as EOL 2024年11月19日 14:42:52 +01:00
mkdocs.v3.yml rename "Sitemap" to "All Documentation" 2024年07月09日 09:55:41 +02:00
README.md no longer refer to "pip" 2024年12月03日 10:07:09 +01:00
upload.sh fix upload.sh 2023年09月14日 23:54:59 +02:00

Introduction

This project is meant to generate the content for docs.eduvpn.org.

It (currently) fetches the eduVPN documentation repository, both v2 and v3 branch and generates the sites using mkdocs.

Preparation

Install mkdocs and git and rsync:

Fedora

$ sudo dnf -y install mkdocs git rsync

Debian / Ubuntu

$ sudo apt -y install mkdocs git rsync

Building

$ ./build.sh

This will perform the following steps (for each branch):

  1. Fetch the documentation repository to vpn-documentation/${BRANCH};
  2. Copies the files to the docs/${BRANCH} directory;
  3. Adds some links to the source repository and last (git) modified date;
  4. Generates a "sitemap"
  5. Runs mkdocs and puts the site output in site/${BRANCH}.

You can manually inspect the output by launching the default browser, e.g.:

$ xdg-open site/v3/index.html

Uploading

See the upload.sh script for more information.

$ ./upload.sh