Directory Structure

The Doks project directory structure extends Hugo's.

.
├── archetypes/
├── assets/
├── config/
├── content/
├── data/
├── layouts/
├── static/
├── .eslintignore
├── .eslintrc.json
├── .markdownlint.json
├── .markdownlintignore
├── .stylelintignore
├── .stylelintrc.json
├── babel.config.js
├── netlify.toml
└── package.json

See also the Hugo docs: Directory Structure.

Root directories#

archetypes#

..
├── blog.md
├── default.md
└── docs.md

See also: Archetypes.

assets#

..
├── fonts/
├── images/
├── js/
│   ├── vendor/
│   └── app.js
├── lambda/
└── scss/
    ├── common/
    ├── components/
    ├── layouts/
    ├── vendor/
    └── app.scss

See also: Assets

config#

..
├── _default/
│   ├── config.toml
│   ├── menus.toml
│   └── params.toml
├── production/
├── staging/
└── postcss.config.js

See also: Project Configuration.

content#

..
├── blog/
├── contributors/
├── docs/
└── _index.md

See also: Pages.

data#

See the Hugo docs: Data Templates.

layouts#

..
├── _default/
│   ├── baseof.html
│   ├── list.html
│   └── single.html
├── blog/
│   └── single.html
├── categories/
│   ├── list.html
│   └── terms.html
├── partials/
│   ├── content/
│   ├── footer/
│   │   ├── footer.html
│   │   └── script-footer.html
│   ├── head/
│   │   ├── favicons.html
│   │   ├── head.html
│   │   ├── opengraph.html
│   │   ├── resource-hints.html
│   │   ├── script-header.html
│   │   ├── seo.html
│   │   ├── structured-data.html
│   │   ├── stylesheet.html
│   │   └── twitter_cards.html
│   ├── header/
│   │   ├── alert.html
│   │   └── header.html
│   └── sidebar/
├── shortcodes/
│   ├── alert.html
│   ├── email.html
│   ├── img-simple.html
│   └── img.html
├── 404.html
├── index.headers
├── index.html
├── index.redirects
├── robots.txt
├── rss.xml
└── sitemap.xml

See also: Layouts.

static#

See the Hugo docs: Static Files

Root files#

.eslintignore#

See the ESLint docs: Ignoring Files and Directories.

.eslintrc.json#

See the ESLint docs: Configuring ESLint.

.markdownlint.json#

See the markdownlint Readme: Rules / Aliases.

.markdownlintignore#

See the markdownlint-cli Readme: Ignoring Files.

.stylelintignore#

See the stylelint docs: Ignoring code.

.stylelintrc.json#

See the stylelint docs: Configuration.

babel.config.js#

See the Babel docs: Configure Babel.

netlify.toml#

See the Netlify docs: File-based configuration.

package.json#

See the npm Docs: package.json.

Edit this page on GitHub