contributions welcome.
Assuming Jekyll and Bundler are installed on your computer:
-
Change your working directory to the root directory of your site.
-
Run
bundle install
. -
Run
bundle exec jekyll serve
to build your site and preview it atlocalhost:4000
.The built site is stored in the directory
_site
.
Is a bare-minimum template to create a Jekyll site that:
- uses the Just the Docs theme;
- can be built and published on GitHub Pages;
- can be built and previewed locally, and published on other platforms.
This repository is licensed under the MIT License. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party starter workflows. A copy of their MIT License is available in actions/starter-workflows.