Developer Programs

Learn

Docs

Installing jhDocs

Getting Started > Installing jhDocs
theme
theme
Hugo
Hugo

Installing jhDocs in a new Hugo site

Follow the steps below to start with Hugo and the jhDocs Hugo theme from scratch.

First, go to the jhDocs starter template repo at https://github.com/jkhy/jhdocs-starter-template.

Documenting APIs?

If your doc site primarily documents APIs using Swagger UI, you should use the API-specific starter template at https://github.com/jkhy/apidocs-template instead of the standard template above.

This template offers the same functionality as the standard starter template, but with placeholders for quickly adding API doc using Swagger UI.

The screenshots below show the standard template, but the two repos are close enough for you to get the point.

Creating a new repo

Then, press the “Use this template” button, then select “Create a new repository”.

Creating a new repo, part 2

Fill out the prompts to create your new repo.

  • Leave Repository template at its current value of jkhy/jhdocs-starter-template.
  • Leave the Include all branches checkbox unchecked.
  • The Owner dropdown allows you to specify which GitHub organization within Jack Henry GitHub where you want this repo to be located.
    • You’ll only see options for the Jack Henry GitHub organizations to which you currently have access.
    • IMPORTANT: Whichever Jack Henry GitHub organization you select here, you will need to work with Jack Henry help desk to ensure that all of your team members who will be contributing to this repo are either already in or are added to that Jack Henry GitHub organization.
  • The Repository name you select for your repo matters. It will be a crucial part of the baseURL you define below. Select a repo name that reflects your product name, is all lowercase, and uses hyphens instead of spaces or underscores.
    • For example, if your product name is “Fraud Detection”, a good repo name might be fraud-detection.
  • The Description is optional, but it can help others who come across your repo understand what it is used for and who to contact with questions.
  • Also make sure you set the repo’s visibility to Internal. This is a best practice for Jack Henry Github repos, allowing others to view them.
Creating a new repo, part 3

Press the Create repository button after you’ve filled in the inputs above.

You now have a fresh new GitHub repo that includes all the files from the starter template, including the jhDocs theme.

GitHub will immediately kick off a build and deploy action for your site. This first action may fail; this is okay because we need to do a little more setup first.

Organization secret required in GitHub organizations

jhDocs relies on an GitHub organization secret named JHDOCS_PRIVATE_KEY having been defined in your repo’s GitHub org in order to function. We currently have this secret defined in the jhky, banno, and JHADigitalCore organizations in Jack Henry GitHub.

If you’re using jhDocs in an organization other than jkhy, banno, or JHADigitalCore, contact us and ask us to set up that organization secret.

Installing jhDocs in an existing Hugo site

Follow these steps to install the jhDocs Hugo theme in an existing Hugo site:

Next topic: Configuring jhDocs

Support options
Have questions on this topic?
Join the jhDocs team in Microsoft Teams to connect with the community.
See something in this page that needs to change?
Send us feedback on this page.

Did this page help you?

Last updated Fri Dec 19 2025