Skip to content

Sources to build EGI documentation site.

License

Notifications You must be signed in to change notification settings

apel/documentation

 
 

Repository files navigation

EGI documentation

Build Status

Deploy Status

Sources files used to build EGI documentation.

If you are interested in contributing please check the Contributing Guide.

Requirements

Installing dependencies, building and testing locally

To install npm+nodejs please check the official instructions.

Everything has been tested with Node.js 12.

The dependencies of the docsy theme can be installed as follows:

# from the root of the repository clone
npm ci

The supported Hugo version is documented under the binaries folder. To help testing a binary version of Hugo (extended version. Updates can be downloaded at the Hugo releases page.

Building the site

# From the repository clone root
git submodule update --init --recursive --depth 1
./binaries/<platform>/hugo --minify

Testing the site locally

# From the repository clone root
./binaries/<platform>/hugo server -D

The website is available locally at: http://localhost:1313/.

Updating the theme

To ease management the docsy theme has been cloned as a git submodule.

Updating the theme submodule

git submodule foreach git pull
git commit themes/docsy -m 'Update theme'

Deployment to the EGI organisation pages

GitHub Actions will automatically deploy a new version when a PR is merged to master, it will then be availalbe at https://docs.egi.eu.

About

Sources to build EGI documentation site.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published