From 94089d2b60ca3cf31c92307e24056751112fbb27 Mon Sep 17 00:00:00 2001 From: Manuel Fuhr Date: Wed, 18 Oct 2023 22:39:02 +0200 Subject: [PATCH] Explain website generation using jekyll --- docs/_README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/_README.md diff --git a/docs/_README.md b/docs/_README.md new file mode 100644 index 0000000..cdda75c --- /dev/null +++ b/docs/_README.md @@ -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`