You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

directory-structure.md 2.0KB

7 years ago
7 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. +++
  2. title = "Directory structure"
  3. weight = 3
  4. +++
  5. After running `zola init`, you should see the following structure in your directory:
  6. ```bash
  7. .
  8. ├── config.toml
  9. ├── content
  10. ├── sass
  11. ├── static
  12. ├── templates
  13. └── themes
  14. 5 directories, 1 file
  15. ```
  16. Here's a high-level overview of each of these directories and `config.toml`.
  17. ## `config.toml`
  18. A mandatory Zola configuration file in TOML format.
  19. This file is explained in detail in the [configuration documentation](@/documentation/getting-started/configuration.md).
  20. ## `content`
  21. Contains all your markup content (mostly `.md` files).
  22. Each child directory of the `content` directory represents a [section](@/documentation/content/section.md)
  23. that contains [pages](@/documentation/content/page.md) (your `.md` files).
  24. To learn more, read the [content overview page](@/documentation/content/overview.md).
  25. ## `sass`
  26. Contains the [Sass](http://sass-lang.com) files to be compiled. Non-Sass files will be ignored.
  27. The directory structure of the `sass` folder will be preserved when copying over the compiled files; for example, a file at
  28. `sass/something/site.scss` will be compiled to `public/something/site.css`.
  29. ## `static`
  30. Contains any kind of file. All the files/directories in the `static` directory will be copied as-is to the output directory.
  31. If your static files are large, you can configure Zola to [hard link](https://en.wikipedia.org/wiki/Hard_link) them
  32. instead of copying them by setting `hard_link_static = true` in the config file.
  33. ## `templates`
  34. Contains all the [Tera](https://tera.netlify.com) templates that will be used to render your site.
  35. Have a look at the [templates documentation](@/documentation/templates/_index.md) to learn more about default templates
  36. and available variables.
  37. ## `themes`
  38. Contains themes that can be used for your site. If you are not planning to use themes, leave this directory empty.
  39. If you want to learn about themes, see the [themes documentation](@/documentation/themes/_index.md).