Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/chipzoller/hugo-clarity.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Boothe <git@rootwork.org>2022-03-25 01:10:02 +0300
committerIvan Boothe <git@rootwork.org>2022-03-25 01:10:02 +0300
commitf8bc9e92f8052b6ece2dffbc60a1131ad5cb1b9c (patch)
tree0c1d30867e362a16e1de0ebb888fb04e6ceb3390 /exampleSite
parentb62024718acd7a9ea1c7fe462827aefb25843549 (diff)
add example bundle
Signed-off-by: Ivan Boothe <git@rootwork.org>
Diffstat (limited to 'exampleSite')
-rw-r--r--exampleSite/content/bundle/building.pngbin0 -> 2593 bytes
-rw-r--r--exampleSite/content/bundle/index.md65
2 files changed, 65 insertions, 0 deletions
diff --git a/exampleSite/content/bundle/building.png b/exampleSite/content/bundle/building.png
new file mode 100644
index 0000000..b437490
--- /dev/null
+++ b/exampleSite/content/bundle/building.png
Binary files differ
diff --git a/exampleSite/content/bundle/index.md b/exampleSite/content/bundle/index.md
new file mode 100644
index 0000000..c9f17fc
--- /dev/null
+++ b/exampleSite/content/bundle/index.md
@@ -0,0 +1,65 @@
+---
+title: 'An example of a Hugo page bundle'
+description: 'Page bundles are an optional way to organize content within Hugo.'
+date: '2022-03-24'
+aliases:
+ - hugo-page-bundles
+author: 'Hugo Authors'
+resources:
+- alt: A building
+ src: building.png
+---
+
+[Page bundles](https://gohugo.io/content-management/page-bundles/) are an optional way to [organize page resources](https://gohugo.io/content-management/page-resources/) within Hugo.
+
+With page bundles, resources for a page or section, like images or attached files, live in the same directory as the content itself rather than in your `static` directory. Page resources in a bundle are only available to the page with which they are bundled, but can be [managed directly from the page's front matter](https://gohugo.io/content-management/page-resources/#page-resources-metadata).
+
+Hugo Clarity supports the use of [leaf bundles](https://gohugo.io/content-management/page-bundles/#leaf-bundles), which are any directories within the `content` directory that contain an `index.md` file. Hugo's documentation gives this example:
+
+```text
+content
+├── about
+│ ├── index.md
+├── posts
+│ ├── my-post
+│ │ ├── content1.md
+│ │ ├── content2.md
+│ │ ├── image1.jpg
+│ │ ├── image2.png
+│ │ └── index.md
+│ └── my-other-post
+│    └── index.md
+│
+└── another-section
+ ├── ..
+    └── not-a-leaf-bundle
+ ├── ..
+    └── another-leaf-bundle
+    └── index.md
+```
+
+<blockquote>
+
+In the above example `content` directory, there are four leaf
+bundles:
+
+**about**: This leaf bundle is at the root level (directly under
+ `content` directory) and has only the `index.md`.
+
+***my-post***: This leaf bundle has the `index.md`, two other content
+ Markdown files and two image files. **image1** is a page resource of `my-post`
+ and only available in `my-post/index.md` resources. **image2** is a page resource of `my-post`
+ and only available in `my-post/index.md` resources.
+
+**my-other-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`.
+
+_The hierarchy depth at which a leaf bundle is created does not matter,
+as long as it is not inside another **leaf** bundle._
+</blockquote>
+
+The image below is part of the bundle of this page, and is located at `content/bundle/building.png`. Because it's within this page's bundle, the markup for the image only has to specify the image's filename.
+
+![A building](building.png)