Samsara uses Jekyll and GitHub pages for its website.
The website is built on Jekyll and uses its built-in SCSS compiler to generate our CSS. Before getting started, you'll need to install the Jekyll gem:
$ gem install jekyllWindows users: Windows users have a bit more work to do, but luckily @juthilo has your back with his Run Jekyll on Windows guide.
To see your Jekyll site, start a Jekyll server. In Terminal, from the /samsara.github.io directory (or whatever your Jekyll site's root directory is named):
$ bundle install
$ bundle exec jekyll serveOpen http://localhost:4000 in your browser, and voilà.
If you host your code on GitHub, you can use GitHub Pages to host your project.
- Fork this repo and switch to the
gh-pagesbranch. - If you're using a custom domain name, modify the
CNAMEfile to point to your new domain. - If you're not using a custom domain name, modify the
baseurlin_config.ymlto point to your GitHub Pages URL. Be sure to include the trailing slash. - Done! Head to your GitHub Pages URL or custom domain.
No matter your production or hosting setup, be sure to verify the baseurl option file and CNAME settings. Not applying this correctly can mean broken styles on your site.
The master copy of the documentation contained in docs/ is the
homonym folder of the samsara/samsara project. So if you want to
update the docs please update it in the main samsara project, then to
publish the documentation copy the new version of the documents here
with:
./bin/update-docs.sh ../samsara/
and commit the changes.