2013-07-06 19:36:30 -04:00
|
|
|
---
|
2014-05-29 18:42:05 -04:00
|
|
|
aliases:
|
|
|
|
- /doc/source-directory/
|
|
|
|
date: 2013-07-01
|
2014-04-23 03:00:11 -04:00
|
|
|
menu:
|
|
|
|
main:
|
2014-05-29 18:42:05 -04:00
|
|
|
parent: getting started
|
|
|
|
next: /content/organization
|
|
|
|
notoc: true
|
|
|
|
prev: /overview/configuration
|
|
|
|
title: Source Organization
|
|
|
|
weight: 50
|
2013-07-08 17:57:01 -04:00
|
|
|
---
|
2013-07-04 11:32:55 -04:00
|
|
|
|
2014-05-27 18:32:57 -04:00
|
|
|
Hugo takes a single directory and uses it as the input for creating a complete
|
|
|
|
website.
|
2013-07-04 11:32:55 -04:00
|
|
|
|
2014-05-27 18:32:57 -04:00
|
|
|
|
|
|
|
The top level of a source directory will typically have the following elements:
|
|
|
|
|
|
|
|
▸ archetypes/
|
|
|
|
▸ content/
|
|
|
|
▸ layouts/
|
|
|
|
▸ static/
|
|
|
|
▸ themes/
|
|
|
|
config.toml
|
|
|
|
|
|
|
|
Learn more about the different directories and what their purpose is
|
|
|
|
|
|
|
|
* [config](/overview/configuration)
|
|
|
|
* [archetypes](/content/archetypes)
|
|
|
|
* [content](/content/organization)
|
|
|
|
* [layouts](/layout/overview)
|
|
|
|
* [static]()
|
|
|
|
* [themes](/themes/overview)
|
|
|
|
|
|
|
|
|
|
|
|
## Example
|
2013-07-04 11:32:55 -04:00
|
|
|
|
|
|
|
An example directory may look like:
|
|
|
|
|
|
|
|
.
|
2014-05-27 18:32:57 -04:00
|
|
|
├── config.toml
|
|
|
|
├── archetypes
|
|
|
|
| └── default.md
|
2013-07-04 11:32:55 -04:00
|
|
|
├── content
|
|
|
|
| ├── post
|
|
|
|
| | ├── firstpost.md
|
|
|
|
| | └── secondpost.md
|
|
|
|
| └── quote
|
|
|
|
| | ├── first.md
|
|
|
|
| | └── second.md
|
|
|
|
├── layouts
|
2014-05-27 18:32:57 -04:00
|
|
|
| ├── _default
|
|
|
|
| | ├── single.html
|
|
|
|
| | └── list.html
|
|
|
|
| ├── partials
|
2013-07-04 11:32:55 -04:00
|
|
|
| | ├── header.html
|
|
|
|
| | └── footer.html
|
2014-05-27 18:32:57 -04:00
|
|
|
| ├── taxonomies
|
2013-07-04 11:32:55 -04:00
|
|
|
| | ├── category.html
|
|
|
|
| | ├── post.html
|
|
|
|
| | ├── quote.html
|
|
|
|
| | └── tag.html
|
|
|
|
| ├── post
|
|
|
|
| | ├── li.html
|
|
|
|
| | ├── single.html
|
|
|
|
| | └── summary.html
|
|
|
|
| ├── quote
|
|
|
|
| | ├── li.html
|
|
|
|
| | ├── single.html
|
|
|
|
| | └── summary.html
|
|
|
|
| ├── shortcodes
|
|
|
|
| | ├── img.html
|
|
|
|
| | ├── vimeo.html
|
|
|
|
| | └── youtube.html
|
|
|
|
| ├── index.html
|
2014-05-07 02:58:25 -04:00
|
|
|
| └── sitemap.xml
|
2014-05-27 18:32:57 -04:00
|
|
|
├── themes
|
|
|
|
| ├── hyde
|
|
|
|
| └── doc
|
2013-08-03 03:30:34 -04:00
|
|
|
└── static
|
2014-05-27 18:32:57 -04:00
|
|
|
├── css
|
|
|
|
└── js
|
2013-07-04 11:32:55 -04:00
|
|
|
|
|
|
|
This directory structure tells us a lot about this site:
|
|
|
|
|
|
|
|
1. the website intends to have two different types of content, posts and quotes.
|
|
|
|
2. It will also apply two different indexes to that content, categories and tags.
|
|
|
|
3. It will be displaying content in 3 different views, a list, a summary and a full page view.
|