diff options
Diffstat (limited to 'docs/content/en/content-management/organization/index.md')
| -rw-r--r-- | docs/content/en/content-management/organization/index.md | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/content/en/content-management/organization/index.md b/docs/content/en/content-management/organization/index.md index c33a25b3a..10e22c2d3 100644 --- a/docs/content/en/content-management/organization/index.md +++ b/docs/content/en/content-management/organization/index.md @@ -24,12 +24,12 @@ Hugo `0.32` announced page-relative images and other resources packaged into `Pa These terms are connected, and you also need to read about [Page Resources]({{< relref "/content-management/page-resources" >}}) and [Image Processing]({{< relref "/content-management/image-processing" >}}) to get the full picture. {{< imgproc 1-featured Resize "300x" >}} -The illustration shows 3 bundles. Note that the home page bundle cannot contain other content pages, but other files (images etc.) are fine. +The illustration shows three bundles. Note that the home page bundle cannot contain other content pages, although other files (images etc.) are allowed. {{< /imgproc >}} {{% note %}} -The bundle documentation is **work in progress**. We will publish more comprehensive docs about this soon. +The bundle documentation is a **work in progress**. We will publish more comprehensive docs about this soon. {{% /note %}} @@ -40,7 +40,7 @@ In Hugo, your content should be organized in a manner that reflects the rendered While Hugo supports content nested at any level, the top levels (i.e. `content/<DIRECTORIES>`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections][]. -Without any additional configuration, the following will just work: +Without any additional configuration, the following will automatically work: ``` . @@ -70,7 +70,7 @@ The following demonstrates the relationships between your content organization a **Tip:** You can get a reference to the content and metadata in `_index.md` using the [`.Site.GetPage` function](/functions/getpage/). {{% /note %}} -You can keep one `_index.md` for your homepage and one in each of your content sections, taxonomies, and taxonomy terms. The following shows typical placement of an `_index.md` that would contain content and front matter for a `posts` section list page on a Hugo website: +You can create one `_index.md` for your homepage and one in each of your content sections, taxonomies, and taxonomy terms. The following shows typical placement of an `_index.md` that would contain content and front matter for a `posts` section list page on a Hugo website: ``` @@ -96,12 +96,12 @@ At build, this will output to the following destination with the associated valu https://example.com/posts/index.html ``` -The [sections][] can be nested as deeply as you need. The important part to understand is, that to make the section tree fully navigational, at least the lower-most section needs a content file. (i.e. `_index.md`). +The [sections] can be nested as deeply as you want. The important thing to understand is that to make the section tree fully navigational, at least the lower-most section must include a content file. (i.e. `_index.md`). ### Single Pages in Sections -Single content files in each of your sections are going to be rendered as [single page templates][singles]. Here is an example of a single `post` within `posts`: +Single content files in each of your sections will be rendered as [single page templates][singles]. Here is an example of a single `post` within `posts`: ``` @@ -112,7 +112,7 @@ Single content files in each of your sections are going to be rendered as [singl content/posts/my-first-hugo-post.md ``` -When Hugo builds your site, the content will be outputted to the following destination: +When Hugo builds your site, the content will be output to the following destination: ``` @@ -128,11 +128,11 @@ https://example.com/posts/my-first-hugo-post/index.html ## Paths Explained -The following concepts will provide more insight into the relationship between your project's organization and the default behaviors of Hugo when building the output website. +The following concepts provide more insight into the relationship between your project's organization and the default Hugo behavior when building output for the website. ### `section` -A default content type is determined by a piece of content's section. `section` is determined by the location within the project's `content` directory. `section` *cannot* be specified or overridden in front matter. +A default content type is determined by the section in which a content item is stored. `section` is determined by the location within the project's `content` directory. `section` *cannot* be specified or overridden in front matter. ### `slug` @@ -152,24 +152,24 @@ A content's `path` is determined by the section's path to the file. The file `pa The `url` is the relative URL for the piece of content. The `url` -* is based on the content's location within the directory structure OR -* is defined in front matter and *overrides all the above* +* is based on the content item's location within the directory structure OR +* is defined in front matter, in which case it *overrides all the above* ## Override Destination Paths via Front Matter -Hugo believes that you organize your content with a purpose. The same structure that works to organize your source content is used to organize the rendered site. As displayed above, the organization of the source content will be mirrored in the destination. +Hugo assumes that your content is organized with a purpose. The same structure that you use to organize your source content is used to organize the rendered site. As displayed above, the organization of the source content will be mirrored at the destination. -There are times where you may need more control over your content. In these cases, there are fields that can be specified in the front matter to determine the destination of a specific piece of content. +There are times when you may need more fine-grained control over the content organization. In such cases, the front matter field can be used to determine the destination of a specific piece of content. -The following items are defined in this order for a specific reason: items explained further down in the list will override earlier items, and not all of these items can be defined in front matter: +The following items are defined in a specific order for a reason: items explained lower down in the list override higher items. Note that not all items can be defined in front matter. ### `filename` -This isn't in the front matter, but is the actual name of the file minus the extension. This will be the name of the file in the destination (e.g., `content/posts/my-post.md` becomes `example.com/posts/my-post/`). +`filename` is not a front matter field. It is the actual file name, minus the extension. This will be the name of the file in the destination (e.g., `content/posts/my-post.md` becomes `example.com/posts/my-post/`). ### `slug` -When defined in the front matter, the `slug` can take the place of the filename for the destination. +When defined in the front matter, the `slug` can take the place of the filename in the destination. {{< code file="content/posts/old-post.md" >}} --- @@ -186,11 +186,11 @@ example.com/posts/new-post/ ### `section` -`section` is determined by a content's location on disk and *cannot* be specified in the front matter. See [sections][] for more information. +`section` is determined by a content item's location on disk and *cannot* be specified in the front matter. See [sections] for more information. ### `type` -A content's `type` is also determined by its location on disk but, unlike `section`, it *can* be specified in the front matter. See [types][]. This can come in especially handy when you want a piece of content to render using a different layout. In the following example, you can create a layout at `layouts/new/mylayout.html` that Hugo will use to render this piece of content, even in the midst of many other posts. +A content item's `type` is also determined by its location on disk but, unlike `section`, it *can* be specified in the front matter. See [types]. This can come in especially handy when you want a piece of content to render using a different layout. In the following example, you can create a layout at `layouts/new/mylayout.html` that Hugo will use to render this piece of content, even in the midst of many other posts. {{< code file="content/posts/my-post.md" >}} --- @@ -206,7 +206,7 @@ layout: mylayout ### `url` -A complete URL can be provided. This will override all the above as it pertains to the end destination. This must be the path from the baseURL (starting with a `/`). `url` will be used exactly as it provided in the front matter and will ignore the `--uglyURLs` setting in your site configuration: +A complete URL can be provided. This will override all the above as it pertains to the end destination. This must be the path from the baseURL (starting with a `/`). `url` will be used exactly as it is defined in the front matter, and will ignore the `--uglyURLs` setting in your site configuration: {{< code file="content/posts/old-url.md" >}} --- |