Directory Structure

The Doks project directory structure extends Hugo’s.

On this page

  1. .
  2. ├── archetypes/
  3. ├── assets/
  4. ├── config/
  5. ├── content/
  6. ├── data/
  7. ├── layouts/
  8. ├── static/
  9. ├── .eslintignore
  10. ├── .eslintrc.json
  11. ├── .markdownlint.json
  12. ├── .markdownlintignore
  13. ├── .stylelintignore
  14. ├── .stylelintrc.json
  15. ├── babel.config.js
  16. ├── netlify.toml
  17. └── package.json

See also the Hugo docs: Directory Structure.

Root directories

archetypes

  1. ..
  2. ├── blog.md
  3. ├── default.md
  4. └── docs.md

See also: Archetypes.

assets

  1. ..
  2. ├── fonts/
  3. ├── images/
  4. ├── js/
  5. │   ├── vendor/
  6. │   └── app.js
  7. ├── lambda/
  8. └── scss/
  9.     ├── common/
  10.     ├── components/
  11.     ├── layouts/
  12.     ├── vendor/
  13.     └── app.scss

See also: Assets

config

  1. ..
  2. ├── _default/
  3. │   ├── config.toml
  4. │   ├── menus.toml
  5. │   └── params.toml
  6. ├── production/
  7. ├── staging/
  8. └── postcss.config.js

See also: Project Configuration.

content

  1. ..
  2. ├── blog/
  3. ├── contributors/
  4. ├── docs/
  5. └── _index.md

See also: Pages.

data

See the Hugo docs: Data Templates.

layouts

  1. ..
  2. ├── _default/
  3. │   ├── baseof.html
  4. │   ├── list.html
  5. │   └── single.html
  6. ├── blog/
  7. │   └── single.html
  8. ├── categories/
  9. │   ├── list.html
  10. │   └── terms.html
  11. ├── partials/
  12. │   ├── content/
  13. │   ├── footer/
  14. │   │   ├── footer.html
  15. │   │   └── script-footer.html
  16. │   ├── head/
  17. │   │   ├── favicons.html
  18. │   │   ├── head.html
  19. │   │   ├── opengraph.html
  20. │   │   ├── resource-hints.html
  21. │   │   ├── script-header.html
  22. │   │   ├── seo.html
  23. │   │   ├── structured-data.html
  24. │   │   ├── stylesheet.html
  25. │   │   └── twitter_cards.html
  26. │   ├── header/
  27. │   │   ├── alert.html
  28. │   │   └── header.html
  29. │   └── sidebar/
  30. ├── shortcodes/
  31. │   ├── alert.html
  32. │   ├── email.html
  33. │   ├── img-simple.html
  34. │   └── img.html
  35. ├── 404.html
  36. ├── index.headers
  37. ├── index.html
  38. ├── index.redirects
  39. ├── robots.txt
  40. ├── rss.xml
  41. └── 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.