zola/docs/content/documentation/getting-started/directory-structure.md
Vincent Prouillet 5b3d17cd2c Fix tera link
2017-10-19 17:07:55 +02:00

1.6 KiB

+++ title = "Directory structure" weight = 3 +++

After running gutenberg init, you should see the following structure in your folder:

.
├── config.toml
├── content
├── sass
├── static
├── templates
└── themes

5 directories, 1 file

Here's a high level overview of each of these folders and config.toml.

config.toml

A mandatory configuration file of Gutenberg in TOML format. It is explained in details in the Configuration page.

content

Where all your markup content lies: this will most likely be mostly .md files. Each folder in the content directory represents a section that contains pages : your .md files.

To learn more, read the content overview.

sass

Contains the Sass files to be compiled. Non-Sass files will be ignored.

static

Contains any kind of files. All the files/folders in the static folder will be copied as-is in the output directory.

templates

Contains all the Tera templates that will be used to render this site. Have a look at the Templates to learn more on the default templates and the variables available.

themes

Contains themes that can be used for that site. If you are not planning to use themes, you can safely ignore this folder and let it be. If you want to learn about themes, head to the themes documentation.