|
| 1 | +--- |
| 2 | +title: Home |
| 3 | +layout: home |
| 4 | +--- |
| 5 | + |
| 6 | +This is a *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. |
| 7 | + |
| 8 | +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. |
| 9 | + |
| 10 | +More specifically, the created site: |
| 11 | + |
| 12 | +- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem |
| 13 | +- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +[Browse our documentation][Just the Docs] to learn more about how to use this theme. |
| 18 | + |
| 19 | +To get started with creating a site, simply: |
| 20 | + |
| 21 | +1. click "[use this template]" to create a GitHub repository |
| 22 | +2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions |
| 23 | + |
| 24 | +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. |
| 25 | + |
| 26 | +---- |
| 27 | + |
| 28 | +[^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). |
| 29 | + |
| 30 | +[Just the Docs]: https://just-the-docs.github.io/just-the-docs/ |
| 31 | +[GitHub Pages]: https://docs.github.com/en/pages |
| 32 | +[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md |
| 33 | +[Jekyll]: https://jekyllrb.com |
| 34 | +[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ |
| 35 | +[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate |
0 commit comments