- Add your site and author details in
_config.yml
. - Add your Google Analytics, Disqus and MailChimp keys to
_config.yml
. - Get a workflow going to see your site's output (with CloudCannon or Jekyll locally).
Base was built with Jekyll version 3.8.4, but should support newer versions as well.
Install the dependencies with Bundler:
$ bundle install
Run jekyll
commands through Bundler to ensure you're using the right versions:
$ bundle exec jekyll serve --incremental
While jekyll is running, you can open the locally hosted version of the docs site on a browser, using http://127.0.0.1:4000/. As you make changes to the source material, the generated site should be updated when reloading.
if you have Docker you also can run your development environment with the follow command
docker run --rm -p 4000:4000 \
--volume="$PWD:/srv/jekyll" \
--volume="$PWD/.vendor/bundle:/usr/local/bundle" \
-it jekyll/jekyll:3.8.4 \
jekyll serve --incremental
Please use Visual Studio Code with Prettier extension to have a consistent coding style
- Add, update or remove a post in the Posts collection.
- The tutorials page is organised by categories.
- Change the defaults when new posts are created in
_posts/_defaults.md
.
- Add post to menu editing
_data/menu.yml
- Exposed as a data file to give clients better access.
- Set in the Data / Navigation section.
- Exposed as a data file to give clients better access.
- Set in the Data / Footer section.
Base template was made by CloudCannon, the Cloud CMS for Jekyll.