blogs/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2026-08-24 23:38:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Page Bundles draft rev 2

Browse Source
This commit is contained in:
Kaushal Modi
2018-01-26 10:59:02 -05:00
committed by Bjørn Erik Pedersen
parent f530d1a7ac
commit 886ed0e109
4 changed files with 143 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/content-management/bundles/_index.md
-20
View File
@@ -1,20 +0,0 @@
---
title : "Bundles"
description : "Content organization using Bundles"
date : 2018-01-24T13:09:00-05:00
lastmod : 2018-01-25T16:35:56-05:00
linktitle : "Bundles"
categories : ["content management", "bundles"]
draft : false
toc : true
menu :
docs:
identifier : "bundles"
parent : "content-management"
weight : 9
---
| Bundle type | Index file name |
|-------------|--------------------------------------------------------------------------|
| Page | `index.md` or `index.html` or any `index.*` file with valid MIME type |
| Section | `_index.md` or `_index.html` or any `_index.*` file with valid MIME type |
content/content-management/bundles/page-bundles/index.md
-61
View File
@@ -1,61 +0,0 @@
---
title : "Page Bundles"
description : "Organization of individual pages as bundles"
date : 2018-01-25T16:45:00-05:00
lastmod : 2018-01-25T16:45:54-05:00
linktitle : "Page Bundles"
keywords : ["page", "bundles"]
categories : ["content management", "bundles"]
weight : 4001
draft : false
toc : true
---
A _Page Bundle_ is any directory at any hierarchy within the
`content/` directory, that contains at least an `index.md` file (**not
`_index.md`**).
{{% note %}}
Here `md` (markdown) is used just as an example. You can use any file
type as a content resource as long as it is a MIME type recognized by
Hugo (`json` files will, as one example, work fine). If you want to
get exotic, you can define your own media type.
{{% /note %}}
## Examples of Page Bundle organization {#examples-of-page-bundle-organization}
```text
content/
├── page-bundle-1
│   ├── content1.md
│   ├── content2.md
│   ├── image1.jpg
│   ├── image2.png
│   └── index.md
└── some-section
├── ..
├── ..
└── page-bundle-2
└── index.md
```
In the above example `content/` directory, there are two page bundles:
`page-bundle-1`
: This page bundle has the `index.md`, two other
content Markdown files and two image files.
`page-bundle-2`
: This page bundle is nested in a section. This
bundle has only the `index.md`.
{{% note %}}
The hierarchy depth at which a page bundle is created does not matter,
as long as it's not inside another **page** bundle.
{{% /note %}}
## Headless Page Bundle {#headless-page-bundle}
**TODO**
content/content-management/bundles/section-bundles/index.md
-57
View File
@@ -1,57 +0,0 @@
---
title : "Section Bundles"
description : "Organization of sections as bundles"
date : 2018-01-25T16:44:00-05:00
lastmod : 2018-01-25T16:45:06-05:00
linktitle : "Section Bundles"
keywords : ["section", "bundles"]
categories : ["content management", "bundles"]
weight : 4002
draft : false
toc : true
---
A _Section Bundle_ is any directory at any hierarchy within the
`content/` directory, that contains at least an `_index.md` file (**not
`index.md`**). This `_index.md` can also be directly under the
`content/` directory.
{{% note %}}
Here `md` (markdown) is used just as an example. You can use any file
type as a content resource as long as it is a MIME type recognized by
Hugo (`json` files will, as one example, work fine). If you want to
get exotic, you can define your own media type.
{{% /note %}}
## Examples of Section Bundle organization {#examples-of-section-bundle-organization}
```text
content/
├── section-bundle-1
│   ├── section-content1.md
│   ├── section-content2.md
│   ├── image1.jpg
│   ├── image2.png
│   └── _index.md
└── section-bundle-2
├── _index.md
└── page-bundle-1
└── index.md
```
In the above example `content/` directory, there are two section
bundles (and a page bundle):
`section-bundle-1`
: This section bundle has the `_index.md`, two
other content Markdown files and two image files.
`section-bundle-2`
: This section bundle has the `_index.md` and a
nested page bundle.
{{% note %}}
The hierarchy depth at which a section bundle is created does not matter,
as long as it's not inside another **section** bundle.
{{% /note %}}
content/content-management/page-bundles.md
+143
View File
@@ -0,0 +1,143 @@
---
title : "Page Bundles"
description : "Content organization using Page Bundles"
date : 2018-01-24T13:09:00-05:00
lastmod : 2018-01-26T10:58:36-05:00
linktitle : "Page Bundles"
keywords : ["page", "bundle", "leaf", "branch"]
categories : ["content management", "bundle"]
draft : false
toc : true
menu :
docs:
identifier : "page-bundles"
parent : "content-management"
weight : 11
---
Page Bundles are a way to organize the content files. It's useful for
cases where a page or section's content needs to be split into
multiple content pages for convenience or has associated attachments
like documents or images.
A Page Bundle can be one of two types:
- Leaf Bundle
- Branch Bundle
| | Leaf Bundle | Branch Bundle |
|-----------------|--------------------------------------------------------|---------------------------------------------------------|
| Usage | Collection of content and attachments for single pages | Collection of content and attachments for section pages |
| Index file name | `index.md` [^fn:1] | `_index.md` [^fn:1] |
| Layout type | `single` | `list` |
| Example | `content/posts/my-post/index.md` | `content/posts/_index.md` |
## Leaf Bundles {#leaf-bundles}
A _Leaf Bundle_ is a directory at any hierarchy within a [Section](/content-management/sections/)
directory, that contains at least an **`index.md`** file.
{{% note %}}
Here `md` (markdown) is used just as an example. You can use any file
type as a content resource as long as it is a MIME type recognized by
Hugo (`json` files will, as one example, work fine). If you want to
get exotic, you can define your own media type.
{{% /note %}}
### Examples of Leaf Bundle organization {#examples-of-leaf-bundle-organization}
```text
content/
├── posts
│ ├── my-post
│ │ ├── content1.md
│ │ ├── content2.md
│ │ ├── image1.jpg
│ │ ├── image2.png
│ │ └── index.md
│ └── my-another-post
│    └── index.md
│
└── another-section
├── ..
   └── not-a-leaf-bundle
├── ..
   └── another-leaf-bundle
   └── index.md
```
In the above example `content/` directory, there are three leaf
bundles:
my-post
: This leaf bundle has the `index.md`, two other content
Markdown files and two image files.
my-another-post
: This leaf bundle has only the `index.md`.
another-leaf-bundle
: This leaf bundle is nested under couple of
directories. This bundle also has only the `index.md`.
{{% note %}}
The hierarchy depth at which a leaf bundle is created does not matter,
as long as (1) it's not inside another **leaf** bundle (2) it's not
directly under the `content/` directory.
{{% /note %}}
### Headless Leaf Bundle {#headless-leaf-bundle}
**TODO**
## Branch Bundles {#branch-bundles}
A _Branch Bundle_ is any directory at any hierarchy within the
`content/` directory, that contains at least an **`_index.md`** file.
This `_index.md` can also be directly under the `content/` directory.
{{% note %}}
Here `md` (markdown) is used just as an example. You can use any file
type as a content resource as long as it is a MIME type recognized by
Hugo (`json` files will, as one example, work fine). If you want to
get exotic, you can define your own media type.
{{% /note %}}
### Examples of Branch Bundle organization {#examples-of-branch-bundle-organization}
```text
content/
├── branch-bundle-1
│   ├── branch-content1.md
│   ├── branch-content2.md
│   ├── image1.jpg
│   ├── image2.png
│   └── _index.md
└── branch-bundle-2
├── _index.md
└── a-leaf-bundle
└── index.md
```
In the above example `content/` directory, there are two branch
bundles (and a leaf bundle):
`branch-bundle-1`
: This branch bundle has the `_index.md`, two
other content Markdown files and two image files.
`branch-bundle-2`
: This branch bundle has the `_index.md` and a
nested leaf bundle.
{{% note %}}
The hierarchy depth at which a branch bundle is created does not matter.
{{% /note %}}
[^fn:1]: The `.md` extension is just an example. The extension can be `.html`, `.json` or any of any valid MIME type.