Explain website generation using jekyll
This commit is contained in:
parent
94a823f805
commit
94089d2b60
1 changed files with 15 additions and 0 deletions
15
docs/_README.md
Normal file
15
docs/_README.md
Normal 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`
|
Loading…
Reference in a new issue