mirror of
https://github.com/getzola/zola
synced 2024-12-16 23:23:07 +00:00
afd5da4f64
* Fix "overriden" to "overridden" typo * Add my website to the EXAMPLES * HTTPS migration for some links * Fix #1295 - Document alpine linux version Fixes: #1295 * Update Zola version on Travis CI example * Documentation improvements and typo fixes * Update more example versions and remove the useless variable on the GitLab CI example * Fix all broken links and theme links
51 lines
2 KiB
Markdown
51 lines
2 KiB
Markdown
+++
|
|
title = "Directory structure"
|
|
weight = 30
|
|
+++
|
|
|
|
After running `zola init`, you should see the following structure in your directory:
|
|
|
|
|
|
```bash
|
|
.
|
|
├── config.toml
|
|
├── content
|
|
├── sass
|
|
├── static
|
|
├── templates
|
|
└── themes
|
|
|
|
5 directories, 1 file
|
|
```
|
|
|
|
Here's a high-level overview of each of these directories and `config.toml`.
|
|
|
|
## `config.toml`
|
|
A mandatory Zola configuration file in TOML format.
|
|
This file is explained in detail in the [configuration documentation](@/documentation/getting-started/configuration.md).
|
|
|
|
## `content`
|
|
Contains all your markup content (mostly `.md` files).
|
|
Each child directory of the `content` directory represents a [section](@/documentation/content/section.md)
|
|
that contains [pages](@/documentation/content/page.md) (your `.md` files).
|
|
|
|
To learn more, read the [content overview page](@/documentation/content/overview.md).
|
|
|
|
## `sass`
|
|
Contains the [Sass](https://sass-lang.com) files to be compiled. Non-Sass files will be ignored.
|
|
The directory structure of the `sass` folder will be preserved when copying over the compiled files; for example, a file at
|
|
`sass/something/site.scss` will be compiled to `public/something/site.css`.
|
|
|
|
## `static`
|
|
Contains any kind of file. All the files/directories in the `static` directory will be copied as-is to the output directory.
|
|
If your static files are large, you can configure Zola to [hard link](https://en.wikipedia.org/wiki/Hard_link) them
|
|
instead of copying them by setting `hard_link_static = true` in the config file.
|
|
|
|
## `templates`
|
|
Contains all the [Tera](https://tera.netlify.com) templates that will be used to render your site.
|
|
Have a look at the [templates documentation](@/documentation/templates/_index.md) to learn more about default templates
|
|
and available variables.
|
|
|
|
## `themes`
|
|
Contains themes that can be used for your site. If you are not planning to use themes, leave this directory empty.
|
|
If you want to learn about themes, see the [themes documentation](@/documentation/themes/_index.md).
|