hugo/docs/content/overview/source-directory.md

91 lines
2.3 KiB
Markdown
Raw Normal View History

2013-07-06 23:36:30 +00:00
---
2014-05-29 22:42:05 +00:00
aliases:
- /doc/source-directory/
date: 2013-07-01
menu:
main:
2014-05-29 22:42:05 +00:00
parent: getting started
next: /content/organization
notoc: true
prev: /overview/configuration
title: Source Organization
weight: 50
---
2013-07-04 15:32:55 +00:00
Hugo takes a single directory and uses it as the input for creating a complete
website.
2013-07-04 15:32:55 +00: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 15:32:55 +00:00
An example directory may look like:
.
├── config.toml
├── archetypes
| └── default.md
2013-07-04 15:32:55 +00:00
├── content
| ├── post
| | ├── firstpost.md
| | └── secondpost.md
| └── quote
| | ├── first.md
| | └── second.md
├── layouts
| ├── _default
| | ├── single.html
| | └── list.html
| ├── partials
2013-07-04 15:32:55 +00:00
| | ├── header.html
| | └── footer.html
| ├── taxonomies
2013-07-04 15:32:55 +00: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 06:58:25 +00:00
| └── sitemap.xml
├── themes
| ├── hyde
| └── doc
2013-08-03 07:30:34 +00:00
└── static
├── css
└── js
2013-07-04 15:32:55 +00: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.