История

Simon Friedberger ec3c8b4fa0 documentation: add info about cmdargs (#1862 ) Co-authored-by: Zeid Zabaneh <2043828+zzzeid@users.noreply.github.com>		2024-10-31 11:38:01 -04:00
..
_data	fetch_configs, launchers: add Fenix nightlies support (bug 1556042) (#1451 )	2023-09-25 13:37:16 -04:00
_includes	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
_layouts	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
_posts	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
_sass	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
css	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
documentation	documentation: add info about cmdargs (#1862 )	2024-10-31 11:38:01 -04:00
images	Move that to a better spot	2021-12-30 10:02:19 -05:00
js	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
Gemfile	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
README.md	Update docs building instructions	2020-03-26 12:45:53 -04:00
_config.yml	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
contribute.md	Add a note about matrix channel	2020-03-26 11:42:58 -04:00
feed.xml	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
index.md	Move docs/ to the master branch (#574 )	2020-03-26 11:38:38 -04:00
install.md	docs: update Python minimum version (#1490 )	2023-10-05 08:16:57 -04:00
quickstart.md	Replace 'inbound' with 'integration' in the about window	2020-06-17 16:59:32 +01:00

Testing documentation

First install bundler for ruby:

gem install bundler

Then, from inside the docs/ directory, install jekyll adapted to github:

bundle install --path vendor/bundle --binstubs --gemfile=$PWD/Gemfile

You can then test your changes with:

bin/jekyll serve --baseurl ''

Note that nodejs may need to be installed on your system to run jekyll.