This is a bare-minimum template to create a Jekyll site that:
More specifically, the created site:
Gemfile
and loads the just-the-docs
gem;To get started with creating a site, just click "use this template"!
After completing the creation of your new site on GitHub, update it as needed:
Update the following files to your own content:
index.md
(your new home page)README.md
(information for those who access your site repo on GitHub)Simply edit the relevant line(s) in the Gemfile
.
The Just the Docs theme automatically includes the jekyll-seo-tag
plugin.
To add an extra plugin, you need to add it in the Gemfile
and in _config.yml
. For example, to add jekyll-default-layout
:
Add the following to your site's Gemfile
:
gem "jekyll-default-layout"
And add the following to your site's _config.yml
:
plugins:
- jekyll-default-layout
Note: If you are using a Jekyll version less than 3.5.0, use the gems
key instead of plugins
.
If your created site is YOUR-USERNAME/YOUR-SITE-NAME
, update _config.yml
to:
title: YOUR TITLE
description: YOUR DESCRIPTION
theme: just-the-docs
url: https://YOUR-USERNAME.github.io/YOUR-SITE-NAME
aux_links: # remove if you don't want this link to appear on your pages
Template Repository: https://github.com/YOUR-USERNAME/YOUR-SITE-NAME
Push your updated _config.yml
to your site on GitHub.
In your newly created repo on GitHub:
Settings
tab -> Pages
-> Build and deployment
, then select Source
: GitHub Actions
.Actions
tab and click on Re-run jobs
.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 at localhost:4000
.
The built site is stored in the directory _site
.
Just upload all the files in the directory _site
.
You're free to customize sites that you create with this template, however you like!
Browse our documentation to learn more about how to use this theme.