pdmosses / just-the-docs-template

WIP: template to use just-the-docs on GitHub pages

Home Page:https://just-the-docs.github.io/just-the-docs-template/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

just-the-docs-template

This is an officially-supported, bare-minimum template to deploy the Just the Docs Jekyll theme to GitHub Pages. More specifically, it:

  • uses a gem-based approach, i.e. uses a Gemfile and loads the just-the-docs gem (pinned to the latest stable)
  • uses the new GitHub Pages / Actions workflow to deploy to pages

Other than that, you're free to customize this template however you'd like! Browse our documentation to learn more about how to use the theme.

To get started:

  • Click the "use this template" button.
  • In your newly created repo, go to the Settings tab -> Pages -> Build and deployment -> Source: GitHub Actions.
    • If there were any failed Actions, go to the Actions tab and click on Re-run jobs.

About

WIP: template to use just-the-docs on GitHub pages

https://just-the-docs.github.io/just-the-docs-template/

License:MIT License


Languages

Language:Ruby 100.0%