You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: index.md
+1-30Lines changed: 1 addition & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,33 +4,4 @@ layout: home
4
4
nav_order: 1
5
5
---
6
6
7
-
This is a TEST *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
8
-
9
-
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
10
-
11
-
More specifically, the created site:
12
-
13
-
- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
14
-
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
15
-
16
-
Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
17
-
18
-
[Browse our documentation][Just the Docs] to learn more about how to use this theme.
19
-
20
-
To get started with creating a site, simply:
21
-
22
-
1. click "[use this template]" to create a GitHub repository
23
-
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
24
-
25
-
If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
26
-
27
-
----
28
-
29
-
[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
30
-
31
-
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
0 commit comments