Project Structure

This guide will show you how a Doks project is organized and what the different files in your project do.

Doks projects generally follow the same file and directory structure as other Hyas projects. See Hyas’ project structure documentation for more detail.

Files and directories#

• config/_default/hugo.toml — The Hugo/site configuration file.
• config/_default/module.toml — The Hugo mounts configuration file.
• config/_default/params.toml — The Doks + Hyas integrations (Images, Inline SVG, and SEO) configuration file.
• content/ — Content files.
• i18n/ (optional) — Translation data to support internationalization,
• assets/ — Assets (scripts, styles, images, etc.) for your project.
• static/ — Static assets (fonts, favicon, PDFs, etc.) that will not be processed.

Example project contents#

A Doks project directory might look like this:

.
├── assets/
├── config/
│   └───_default/
│       ├───hugo.toml
│       ├───menus.toml
│       ├───module.toml
│       └───params.toml
├── content/
│   └───docs/
│       ├───guides/
│       │   ├───_index.md
│       │   └───getting-started.md
│       └───_index.md
├── i18n/
├── layouts/
├── static/
└── package.json