This site contains documentation for livedigital products:
livedigital WebRTC conferencing
Contributing to livedigital Docs
Docs site is generated by Jekyll from markdown files stored in docs repo. When you push into
main branch, GitHub Action will be triggered to generate and publish updated version. Be aware that when Jekyll is .
Jekyl configuration is stored in
_config.yml file. In this file you may change structure of categories, add plugins, set site meta, select a theme.
We use Just the Docs theme to render final HTML pages. It is hosted in its own GitHub repo and is configured as a remote theme.
Follow these steps to work with livedigital Docs:
Clone docs repo:
git clone firstname.lastname@example.org:VLprojects/docs.git
Install Bundler if you don’t have it yet:
gem install bundler
Install other dependencies needed to run Jekyll locally:
cd docs bundle install
Make changes or create new documents in
Test changes locally:
bundle exec jekyll server --livereload
Open http://127.0.0.1:4000/docs/ and explore your pages. With
--livereloadflag, pages are rendered automatically as you save them on disk. If you’ve touched
_config.ymlfile, relaunch jekyll server to make changes come into effect.
If everything looks fine, push your changes into
Check that updated docs are built, published and look fine. Wait until a new workflow run becomes green on the Actions page. Open https://vlprojects.github.io/docs/ and explore your pages.