Here we explain how to edit this documentation locally and submit changes for online publication.
Our web site repository contains two branches.
Master branch contains markdown content of the site,
gh-pages branch contains static html of the site.
Hugo static site generator is used to produce html content from markdown pages.
GitHub is configured to host content of
gh-pages branch at this address.
Users are modifying site content by providing pull requests to
Travis continuous integration automatically generates
fresh html of the site and updates
To modify documentation follow these steps:
$HOME/bindirectory, for example.
Make a fork of our site repository and clone your fork locally.
Please note, that repository contains submodule (external Hugo theme), so clone command should be
git clone --recurse-submodules https://github.com/<your-name>/BornAgain-website.git
Besides the usual
git pull, we also need to update the submodule:
git pull git pull --recurse-submodules git submodule update --remote --recursive
Go to cloned repository and run
$ cd <source> $ hugo server -D
Open web-browser using address Hugo will tell you (most probably http://localhost:1313/).
The documentation sources are in directory
They consist of Markdown files.
For example, the source of the page you are looking at right now, is
Edit any source file.
Hugo will then update the web site within a fraction of a second.
When you are happy with the changes you’ve made, commit them, push them to
and create a pull request.
Travis will start the build to make sure that site is still in working state (no broken links found, etc).
Travis mood and load, the build can be completed in less than a minute.
Members of scgmlz have rights to merge their own pull requests. External users will have to wait a bit for a person with admin rights to approve.
After pull request merge, check site online. It might take a few minutes before changes will be propagated to hosting service.
reloadbutton while holding
shiftkey). See also bypass your cache.