Link Search Menu Expand Document

Get a copy of this template project which you can easily run and host on your GitHub account.

  1. Click this button.
    • Use this template
  2. Go to your repo’s Actions tab and wait for the first workflow to pass.
  3. Check your gh-pages branch which was created and see that it has a some static HTML files and assets in it.
  4. Go to your repo’s Settings.
  5. Enable a GitHub Pages site on the root path of the gh-pages branch.
  6. Go to the Environment section on the right of repo to check the status of the build.
  7. When it is done, click View Deployment to open your site URL.

Then you can customize the config, theme, plugins, etc. as you need to.

The Just The Docs theme picks up files automatically and adds them to the navbar, so if you are happy with alphabetical menu, then so you don’t have to worry about configuring a navbar. You can also set a custom ordering using nav_order: 1 to put the page first, as such as homepage.