Explain website generation using jekyll

This commit is contained in:
Manuel Fuhr 2023-10-18 22:39:02 +02:00
parent 94a823f805
commit 94089d2b60

15
docs/_README.md Normal file
View file

@ -0,0 +1,15 @@
# BRouter Docs
This documentation can be used to generate a static website using [jekyll](https://jekyllrb.com/).
## Dependencies
jekyll uses ruby and therefore installs dependencies using gem. It is recommended to use bundler to manage those dependencies.
`bundle install` installs all dependencies. To update dependencies use `bundle update`.
## Preview
jekyll provides a built-in webserver which can be used for fast feedback during editing.
`bundle exec jekyll serve`