mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2025-05-16 15:04:03 +00:00
theme: move content views #1086
This commit is contained in:
Sören Weber
parent
fd809dc523
commit
2ec62814fa
22 changed files with 35 additions and 35 deletions
docs/content/configuration/customization
|
|
@ -33,9 +33,9 @@ The shipped `print` and `markdown` output formats only display using the `defaul
|
|||
Suppose you are writing a documentation site for some software. Each time a new release is created, you are adding a new releasenotes page to your site. Those pages should contain a common disclaimer at the top. You neither want to copy the text into each new file nor want you to use a shortcode but create a page design called `releasenotes`.
|
||||
|
||||
1. Choose a name (here, `releasenotes`)
|
||||
2. Create a content view file at `layouts/releasenotes/views/article.html`
|
||||
2. Create a content view file at `layouts/releasenotes/article.html`
|
||||
|
||||
````html {title="layouts/releasenotes/views/article.html" hl_Lines="6-8"}
|
||||
````html {title="layouts/releasenotes/article.html" hl_Lines="6-8"}
|
||||
<article class="releasenotes">
|
||||
<header class="headline">
|
||||
{{partial "content-header.html" .}}
|
||||
|
|
@ -51,7 +51,7 @@ Suppose you are writing a documentation site for some software. Each time a new
|
|||
</article>
|
||||
````
|
||||
|
||||
The marked lines are your customizations, the rest of the file was copied over from the default implementation of [`layouts/_default/views/article.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/views/article.html)
|
||||
The marked lines are your customizations, the rest of the file was copied over from the default implementation of [`layouts/_default/article.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/article.html)
|
||||
|
||||
In this file, you can customize the page structure as needed. For HTML based output formats, typically you'll want to:
|
||||
|
||||
|
|
@ -92,20 +92,20 @@ These files are common for all output formats.
|
|||
|
||||
If you want to keep the general HTML framework and only change specific parts, you can provide these files for the page desingn for the HTML output format independently of one another.
|
||||
|
||||
- `layouts/<DESIGN>/views/article.html`: _Optional_: Controls how one page's content and title are displayed
|
||||
- `layouts/<DESIGN>/views/body.html`: _Optional_: Determines what to contain in the content area (for example a single page, a list of pages, a tree of sub pages)
|
||||
- `layouts/<DESIGN>/views/menu.html`: _Optional_: Defines the sidebar menu layout
|
||||
- `layouts/<DESIGN>/article.html`: _Optional_: Controls how one page's content and title are displayed
|
||||
- `layouts/<DESIGN>/body.html`: _Optional_: Determines what to contain in the content area (for example a single page, a list of pages, a tree of sub pages)
|
||||
- `layouts/<DESIGN>/menu.html`: _Optional_: Defines the sidebar menu layout
|
||||
|
||||
For a real-world example, check out the `changelog` page design implementation
|
||||
|
||||
- [`docs/layouts/changelog/views/article.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/docs/layouts/changelog/views/article.html)
|
||||
- [`docs/layouts/changelog/article.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/docs/layouts/changelog/article.html)
|
||||
|
||||
## Migration to Relearn 7 or higher
|
||||
|
||||
Previous to Relearn 7, page designs were defined by a proprietary solution unique to the theme. Depending on your modifications you may have to change some or all of the following to migrate to Relearn 7's page designs.
|
||||
|
||||
- In all your `*.md` files, replace the `archetype` front matter with `type`; the value stays the same; don't forget your archetype files if you have some
|
||||
- Move your files `layouts/partials/archetypes/<DESIGN>/article.html` to `layouts/<DESIGN>/views/article.html`
|
||||
- Move your files `layouts/partials/archetypes/<DESIGN>/article.html` to `layouts/<DESIGN>/article.html`
|
||||
|
||||
The files will most likely require further modifications as they now receive the page as it context (dot `.`) instead of the `.page` and `.content` parameter.
|
||||
|
||||
|
|
@ -132,7 +132,7 @@ Previous to Relearn 7, page designs were defined by a proprietary solution uniqu
|
|||
|
||||
**New**:
|
||||
|
||||
````html {title="layouts/<DESIGN>/views/article.html" hl_Lines="7"}
|
||||
````html {title="layouts/<DESIGN>/article.html" hl_Lines="7"}
|
||||
<article class="default">
|
||||
<header class="headline">
|
||||
{{- partial "content-header.html" . }}
|
||||
|
|
|
|||
|
|
@ -60,11 +60,11 @@ Therefore we add a new output format called `email` that outputs HTML and assemb
|
|||
|
||||
The marked `block` construct above will cause the display of the article with a default HTML structure. In case you want to keep it really simple, you could replace this line with just `{{ .Content }}`.
|
||||
|
||||
3. _Optional_: create a file `layouts/_default/views/article.email.html`
|
||||
3. _Optional_: create a file `layouts/_default/article.email.html`
|
||||
|
||||
In our case, we want to display a disclaimer in front of every article. To do this we have to define the output of an article ourself and rely on the above `block` statement to call our template.
|
||||
|
||||
````html {title="layouts/_default/views/article.email.html"}
|
||||
````html {title="layouts/_default/article.email.html"}
|
||||
<article class="email">
|
||||
<blockquote>
|
||||
View this article on <a href="http://example.com{{ .RelPermalink }}">our website</a>
|
||||
|
|
@ -100,16 +100,16 @@ Therefore we add a new output format called `email` that outputs HTML and assemb
|
|||
|
||||
If you want to keep the general HTML framework and only change specific parts, you can provide these files for your output format independently of one another:
|
||||
|
||||
- `layouts/_default/views/article.<FORMAT>.html`: _Optional_: Controls how a page's content and title are displayed
|
||||
- `layouts/_default/views/body.<FORMAT>.html`: _Optional_: Determines what to contain in the content area (for example a single page, a list of pages, a tree of sub pages)
|
||||
- `layouts/_default/views/menu.<FORMAT>.html`: _Optional_: Defines the sidebar menu layout
|
||||
- `layouts/_default/views/storeOutputFormat.<FORMAT>.html`: _Optional_: Stores the output format name for use in the framework to let the body element been marked with an output format specific class
|
||||
- `layouts/_default/article.<FORMAT>.html`: _Optional_: Controls how a page's content and title are displayed
|
||||
- `layouts/_default/body.<FORMAT>.html`: _Optional_: Determines what to contain in the content area (for example a single page, a list of pages, a tree of sub pages)
|
||||
- `layouts/_default/menu.<FORMAT>.html`: _Optional_: Defines the sidebar menu layout
|
||||
- `layouts/_default/storeOutputFormat.<FORMAT>.html`: _Optional_: Stores the output format name for use in the framework to let the body element been marked with an output format specific class
|
||||
|
||||
For a real-world example, check out the `print` output format implementation
|
||||
|
||||
- [`layouts/_default/views/body.print.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/views/body.print.html)
|
||||
- [`layouts/_default/views/menu.print.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/views/menu.print.html)
|
||||
- [`layouts/_default/views/storeOutputFormat.print.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/views/storeOutputFormat.print.html)
|
||||
- [`layouts/_default/body.print.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/body.print.html)
|
||||
- [`layouts/_default/menu.print.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/menu.print.html)
|
||||
- [`layouts/_default/storeOutputFormat.print.html`](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/storeOutputFormat.print.html)
|
||||
|
||||
### For Non-HTML Output Formats
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ Previous to Relearn 7, HTML output formats did not use the `baseof.html` but now
|
|||
|
||||
### For HTML Output Formats
|
||||
|
||||
- Move your files `layouts/partials/article.<FORMAT>.html` to `layouts/_default/views/article.<FORMAT>.html`
|
||||
- Move your files `layouts/partials/article.<FORMAT>.html` to `layouts/_default/article.<FORMAT>.html`
|
||||
|
||||
The files will most likely require further modifications as they now receive the page as it context (dot `.`) instead of the `.page` and `.content` parameter.
|
||||
|
||||
|
|
@ -156,7 +156,7 @@ Previous to Relearn 7, HTML output formats did not use the `baseof.html` but now
|
|||
|
||||
**New**:
|
||||
|
||||
````html {title="layouts/_default/views/article.<FORMAT>.html" hl_Lines="7"}
|
||||
````html {title="layouts/_default/article.<FORMAT>.html" hl_Lines="7"}
|
||||
<article class="default">
|
||||
<header class="headline">
|
||||
{{- partial "content-header.html" . }}
|
||||
|
|
@ -204,7 +204,7 @@ Previous to Relearn 7, HTML output formats did not use the `baseof.html` but now
|
|||
|
||||
The upper part of the file is from your `header.<FORMAT>.html` and the lower part is from your `footer.<FORMAT>.html`.
|
||||
|
||||
The marked line needs to be added, so your output format uses a potential `layouts/_default/views/article.<FORMAT>.html`
|
||||
The marked line needs to be added, so your output format uses a potential `layouts/_default/article.<FORMAT>.html`
|
||||
|
||||
````html {title="layouts/_default/baseof.<FORMAT>.html" hl_Lines="15"}
|
||||
<!DOCTYPE html>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue