https://github.com/feltor-dev/feltor-dev.github.io
Homepage
https://github.com/feltor-dev/feltor-dev.github.io
Last synced: about 2 months ago
JSON representation
Homepage
- Host: GitHub
- URL: https://github.com/feltor-dev/feltor-dev.github.io
- Owner: feltor-dev
- License: mit
- Created: 2017-11-15T09:33:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2026-04-08T09:26:50.000Z (about 2 months ago)
- Last Synced: 2026-04-08T11:24:25.430Z (about 2 months ago)
- Language: CSS
- Size: 135 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Welcome to the FELTOR homepage repository
#### How to view homepage locally
Install [jekyll](https://jekyllrb.com/) to locally view the homepage:
```sh
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//bin` to your `PATH` variable.
You might need to run
```sh
bundle install
```
before running the serve command.
If you get errors about the port already being in use just use another using
```sh
bundle exec jekyll serve --port 4001
# => Now browse to http://localhost:4001
```
#### 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/topics.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).
```bash
pip install ghp-import
```
Please also make sure that you have the `doxygen` `>=1.9.8`,
`libjs-mathjax` `doxygen-awesome` and `graphviz` packages and a LateX installation (including the
hitec.cls package) to create the documentation.
```bash
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
```sh
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](https://en.wikipedia.org/wiki/0.0.0.0) `0.0.0.0` and
find out the IP address of your system with `hostname -I`
```sh
hostname -I
bundle exec jekyll serve --host 0.0.0.0
# => Now browse to http://: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](LICENSE) for details