This repository is the home for the source files which are used to generate the content for modprox.org
The site is generated using the popular hugo static website generator. You'll need to have it installed locally in order to run it as a local development webserver and to generate the final static content for deployment.
The theme being used is kraiklyn. Additional theme-specific documentation can be found in the project's repository.
The theme lives in the themes/ directory as a git submodule. Before launching locally for the first time, the submodule needs to be initialized and downloaded:
$ git submodule init
Submodule 'themes/kraiklyn' (git@github.com:jsnjack/kraiklyn.git) registered for path 'themes/kraiklyn'
$ git submodule update
Cloning into '/home/hoenig/Documents/go/src/github.com/modprox/modprox-org/themes/kraiklyn'...
The script build.sh can be used to startup a hugo server in local mode for testing changes. To
to this, simply run the build.sh script with no arguments (make sure hugo is installed first).
The hugo server automatically reloads changes to any files, and makes the change visible without
needing to restart.
$ ./build.sh
running site in local mode
...
Web Server is available at //localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop
By default the local development server uses localhost as the base URL and 127.0.0.0 as the bind
address. These values can be configured by setting the HUGO_BASE_URL and HUGO_BIND_ADDR environment
variables before running the build.sh script.
The script build.sh can be used to publish an archive of the generated static site, for use in a
production environment behind a normal static file server (e.g. caddy).