Welcome to the FELTOR homepage repository

How to view homepage locally

Install jekyll to locally view the homepage:

gem install bundler jekyll
bundle exec jekyll serve
# => Now browse to http://localhost:4000

If you run into trouble with missing write permissions do not run with sudo, use the gem install bundler --user-install jekyll option and add ~/.gem/ruby/<ruby version>/bin to your PATH variable. You might need to run

bundle install

before running the serve command.

How to update (doxygen) documentation

We host the doxygen documentation on the gh-pages branch of the https://github.com/mwiesenberger/feltor repository visible on https://mwiesenberger.github.io/feltor/dg/html/modules.html. To update we use ghp-import with the -o option, such that the gh-pages always contains only a single commit (to save space; and the history of documentation is contained in the main branch).

pip install ghp-import

Please also make sure that you have the doxygen >=1.9.3, libjs-mathjax and graphviz packages and a LateX installation (including the hitec.cls package) to create the documentation.

cd path/to/feltor/doc
make clean
make doc
cd ..
ghp-import -n -f -p -o doc

How to update gems with bundler

Sometimes there are security vulnerabilities in some outdated dependencies. Then it is time to run

bundle update

which will update every gem in the Gemfile to the latest versions

How to view homepage over local wifi

Use the magic IP 0.0.0.0 and find out the IP address of your system with hostname -I

hostname -I
bundle exec jekyll serve --host 0.0.0.0
# => Now browse to http://<your-IP-address>:4000
# from any browser in your wifi (it is still "localhost" on your own machine)

Authors and contributions

The Feltor homepage is maintained by Markus Held and Matthias Wiesenberger. Contributions and/or comments are welcome.

License

This project is licensed under the MIT license - see LICENSE for details