Roles
Three elements are involved in maintaining your jhDocs documentation site:
- Your team
- Hugo
- The jhDocs theme
This section talks about the roles played by each of the above.
Your team’s role
Your team manages each page of your content as
individual markdown files, stored in your site’s content folder.
If your content has a hierarchical structure, you can optionally nest
your markdown content in subfolders beneath the content folder.
Hugo’s role
Hugo takes your markdown-based content and transforms it into a full HTML-based static website. This process is fast; Hugo is known and loved for its speed.
You deploy and host the Hugo-generated website on a web server.
Hugo can also serve your site locally as you develop the content on your machine with hot reload capability, making it easy to see your changes as you make them.
The site that Hugo generates is unthemed. All styling comes from the jhDocs theme, which we talk about next.
The jhDocs theme’s role
The jhDocs theme (found in the themes/jhdocs folder) takes the site
generated by Hugo and adds magic, including:
- A modern, accessible themed appearance that supports both light mode and dark mode
- Site search fully baked in, provided using the Pagefind utility
- Support for AI Assist can be configured in jhDocs if you have set up an AskJack agent and knowledge base.
- A library of icons for your top-level nav items
- A header with:
- Your site title
- A hamburger button that displays the nav bar at mobile size
- A search box at desktop size, replaced by a smaller search button at mobile size
- A dropdown for linking to other Jack Henry Docs sites
- An automatically generated nav bar, always visible at desktop and tablet sizes and accessible at mobile size by pressing the hamburger button in the header
- An automatically generated table of contents that displays as a list of links at desktop size and a more compact selector at tablet and mobile size
- A default 404 (page not found) page
- All web font files needed by the theme