+++ title = “Overview” weight = 10 +++
Gutenberg uses the folder structure to determine the site structure.
Each folder in the content
directory represents a section
that contains pages : your .md
files.
.
└── content
├── content
│ └── something.md // -> https://mywebsite.com/content/something/
├── blog
│ ├── cli-usage.md // -> https://mywebsite.com/blog/cli-usage/
│ ├── configuration.md // -> https://mywebsite.com/blog/configuration/
│ ├── directory-structure.md // -> https://mywebsite.com/blog/directory-structure/
│ ├── _index.md // -> https://mywebsite.com/blog/
│ └── installation.md // -> https://mywebsite.com/blog/installation/
└── landing
└── _index.md // -> https://mywebsite.com/landing/
Obviously, each page path (the part after the base_url
, for example blog/
) can be customised by setting the wanted value
in the page front-matter.
You might have noticed a file named _index.md
in the example above.
This file will be used for the metadata and content of the section itself and is not considered a page.
To make sure the terminology used in the rest of the documentation is understood, let's go over the example above.
The content
directory in this case has three sections
: content
, blog
and landing
. The content
section has only
one page, something.md
, the landing
section has no page and the blog
section has 4 pages: cli-usage.md
, configuration.md
, directory-structure.md
and installation.md
.
While not shown in the example, sections can be nested indefinitely.
The content
directory is not limited to markup files though: it's natural to want to co-locate a page and some related
assets. Gutenberg supports that pattern out of the box: create a folder, add a index.md
file and as many non-markdown as you want.
Those assets will be copied in the same folder when building so you can just use a relative path to access them.
└── with-assets
├── index.md
└── yavascript.js