Content organization

A structured approach to organize and present content.

Hinode uses a structured approach to organize and present content. This results in user-friendly URLs, which are also easy to crawl by search engines. The following paragraphs describe how to organize the content and how to define alternative paths.

Organization of content

Hinode recognizes three basic types of pages:

• List pages provide an overview of single pages within the same section
• Single pages define a specific page that get published to a specific permalink
• Content snippets provide input for a specific page, but do not have a permalink of their own

All content resides in the content folder of the repository. The content for multilanguage sites uses seperate subfolders for each language directly below the content folder. Usually a list page is defined by having an _index.md within its folder. A notable exception is the home page, which is defined in the content root folder. The next diagram illustrates a typical initial setup for a Hinode website that supports the English language.

.
└── content
    └── en                        // <- [Language]
        └── _index.md             // <- [Home page]   https://example.com/en
        └── about.md              // <- [Single page] https://example.com/en/about
        └── blog
        |   ├── _index.md         // <- [List page]   https://example.com/en/posts/
        |   └── first-post.md     // <- [Single page] https://example.com/en/posts/first-post/
        └── features
        |   ├── index.md          // <- [bundle]      not published separately
        |   └── my-feature.md     // <- [snippet]     not published separately
        └── projects
            ├── _index.md         // <- [List page]   https://example.com/en/projects/
            └── first-project.md  // <- [Single page] https://example.com/en/projects/first-project/

Defining alternative paths

You can adjust the path or provide an alias of a page in its frontmatter. For example, the following aliases ensure the introduction of the Hinode docs is available on four alternative paths:

---
title: Introduction
aliases:
  - "/docs/0.9/getting-started/"
  - "/docs/getting-started/"
  - "/getting-started/"
  - "/docs/"
layout: docs
---

Similarly, you can link multiple translations of a page and still provide a language-specific path. See the languages configuration for more details.

Configuring content snippets

Hinode supports content snippets that are not published anywhere, unlike list pages and single pages. These snippets can be referenced by regular pages instead. A typical example would be an overview of product features. The features themselves can be listed on the homepage, but do not have a permalink of their own. Content snippets can be listed like a regular section.

Add a file index.md to the root of your section that contains your code snippets (please observe the absence of the ‘_’ prefix). Set the parameter headless to true in file’s frontmatter to make the section headless:

---
headless: true
---