Getting Started
Doks is a full-featured documentation theme built on top of the Hyas framework. This guide will help you get started with a new project.
Quick Start
Create a new project
Create a new Hyas + Doks project by running the following command in your terminal:
This will create a new project directory with all the necessary files and configurations for your site.
See it in action
Try Doks in your browser: open the template on Gitpod.
Install dependencies
cd into your new project directory and install the dependencies before continuing.
Start the development server
When working locally, Hugo’s development server lets you preview your work and automatically refreshes your browser when you make changes.
Inside your project directory, run the following command to start the development server:
This will log a message to your terminal with the URL of your local preview. Open this URL to start browsing your site.
Add content
Doks is ready for you to add new content, or bring your existing files!
File formats
Doks supports authoring content in Markdown and HTML with no configuration required. You can add support for Emacs Org-Mode, AsciiDoc, RST, and Pandoc by installing additional parsers.
Add pages
Add new pages to your site by creating .md or .html files in content/docs/. Use sub-folders to organize your files and to create multiple path segments.
For example, the following command will generate a page at example.com/docs/guides/faq:
Frontmatter
All Doks pages share a customizable common set of frontmatter properties to control how the page appears — for documentation pages:
---
title: "Example Guide"
description: ""
summary: ""
date: 2023-09-07T16:04:48+02:00
lastmod: 2023-09-07T16:04:48+02:00
draft: true
weight: 999
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---Next steps
- Configure: Learn about common options in “Customizing Doks”.
- Navigate: Set up your sidebar with the “Sidebar Navigation” guide.
- Shortcodes: Discover built-in callouts, tabs, and more in the “Shortcodes” guide.
- Deploy: Publish your work with the “Deploy your site” guide in the Hyas docs.
Updating Doks
Doks is a Hyas theme, and is updated like any @hyas/* theme (or integration):
See the Doks changelog for a full list of the changes made in each release.
Upgrade guides
- Need to upgrade from Doks v0.5? See the Upgrade to v1 guide.
- Need to upgrade a v1.x project? See our other migration guides.
Troubleshooting Doks
Use the project configuration and individual page frontmatter configuration reference pages to ensure that your Doks site is configured and functioning properly. See the guides in the sidebar for help adding content and customizing your Doks site.
If your answer cannot be found in these docs, please visit the full Hyas Docs for complete Hyas documentation. Your question may be answered by understanding how Hyas works in general, underneath this Doks theme.
You can also check for any known Doks issues on GitHub, and get help in Doks Discussions from our active, friendly community!