hugo-theme-relearn/exampleSite/content/configuration/customization/outputformats/_index.en.md

+++
categories = ["explanation", "howto"]
description = "Adding Custom Output Formats"
title = "Output Formats"
weight = 6
+++

In addition to the [output formats coming with the theme](configuration/sitemanagement/outputformats), you can create your own [output formats](https://gohugo.io/templates/output-formats/).

## Starting from Scratch

If you want to add a new output format called `myformat` that outputs HTML and you want to build everything yourself without using the theme's components:

1. Create a file `layouts/_default/baseof.myformat.html`
2. Implement all the necessary code in this file

## Using the Theme's Structure

If you want to keep the general framework and only change specific parts, you can override these files:

- `layouts/_default/views/article.html`: Controls how a page's content and title are displayed
- `layouts/_default/views/body.html`: Determines the page body structure
- `layouts/_default/views/menu.html`: Defines the sidebar menu layout
- `layouts/_default/views/storeOutputFormat.html`: Stores the output format name for use in the framework

For a real-world example, check out the `print` output format implementations

- [`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)
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00			`+++`
docs: add categories taxonomy #567 2024-10-12 17:28:28 +00:00			`categories = ["explanation", "howto"]`
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00			`description = "Adding Custom Output Formats"`
docs: finally feature complete for chapter 2 #567 2024-10-08 20:28:16 +00:00			`title = "Output Formats"`
			`weight = 6`
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00			`+++`

docs: review #567 2024-10-07 13:30:53 +00:00			`In addition to the [output formats coming with the theme](configuration/sitemanagement/outputformats), you can create your own [output formats](https://gohugo.io/templates/output-formats/).`
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00
docs: review #567 2024-10-07 13:30:53 +00:00			`## Starting from Scratch`
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00
docs: review #567 2024-10-07 13:30:53 +00:00			If you want to add a new output format called `myformat` that outputs HTML and you want to build everything yourself without using the theme's components:
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00
docs: review #567 2024-10-07 13:30:53 +00:00			1. Create a file `layouts/_default/baseof.myformat.html`
			`2. Implement all the necessary code in this file`
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00
docs: review #567 2024-10-07 13:30:53 +00:00			`## Using the Theme's Structure`
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00
docs: review #567 2024-10-07 13:30:53 +00:00			`If you want to keep the general framework and only change specific parts, you can override these files:`
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00
docs: review #567 2024-10-07 13:30:53 +00:00			- `layouts/_default/views/article.html`: Controls how a page's content and title are displayed
			- `layouts/_default/views/body.html`: Determines the page body structure
			- `layouts/_default/views/menu.html`: Defines the sidebar menu layout
			- `layouts/_default/views/storeOutputFormat.html`: Stores the output format name for use in the framework
docs: first draft chapter 2 #567 2024-09-29 21:48:56 +00:00
docs: review #567 2024-10-07 13:30:53 +00:00			For a real-world example, check out the `print` output format implementations

			- [`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)