{"repo":"just-the-docs/just-the-docs-template","free":true,"listed":false,"github":"https://github.com/just-the-docs/just-the-docs-template","clone":"git clone https://github.com/just-the-docs/just-the-docs-template.git","description":"one-click template to use just-the-docs on GitHub Pages","language":"Ruby","stars":226,"topics":["github-pages","jekyll","just-the-docs","template"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"just-the-docs-template This 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. More specifically, the created site: - uses a gem-based approach, i.e. uses a Gemfile and loads the just-the-docs gem; - uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages. To get started with creating a site, simply: 1. click \"[use this template]\" to create a GitHub repository 2. go to Settings Pages Build and deployment Source, and select GitHub Actions 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. After completing the creation of your new site on GitHub, update it as needed: Replace the content of the template pages 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) Changing the version of the theme and/or Jekyll Simply edit the relevant line(s) in the Gemfile . Adding a plugin 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 : - And add the following to your site's config.yml : Note: If you are using a Jekyll versio","default_branch":null,"files":null,"tree":[],"storefront":"/r/just-the-docs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/just-the-docs/just-the-docs-template/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}