hugo/content/contribute/documentation.md at 4c446c6aaefb1fa53cf7891c893ad32bdbabf5a8

blogs/hugo

Fork 0

mirror of https://github.com/gohugoio/hugo.git synced 2026-09-03 04:02:38 +00:00

Files

T

Ryan Watters 2af9243efa Update required fields icon in lists, esp contrib to docs

2017-02-27 21:54:55 -06:00

16 KiB

Raw Blame History

title, linktitle, description, date, publishdate, lastmod, categories, tags, weight, draft, aliases, toc, wip

title

linktitle

description

date

publishdate

lastmod

Create Your Fork

It's best to make changes to the Hugo docs on your local machine to check for consistent visual styling. Make sure you've created a fork of Hugo on GitHub and cloned the repository locally on your computer. For more information, you can use the GitHub docs for "forking" or see Hugo's extensive development contribution guide.

You can then create a separate branch for your additions. Note that you can choose a different descriptive branch name that best fits the type of content. The following is an example of a branch name you might use for adding a new website to the showcase:

git checkout -b jon-doe-showcase-addition

Adding New Content

The Hugo docs are built using Hugo and therefore make heavy use of Hugo's archetypes feature to easily scaffold new instances of content types. All content sections in Hugo documentation have an assigned archetype (see the Hugo docs archetype source).

Adding new content follows the same pattern, regardless of the content section:

hugo new <docssection>/<newcontent-all-lowercase.md>

{{% note "title:, date:, and Field Order" %}} title and date fields are added automatically when using archetypes via hugo new. Do not be worried if the order of the new file's front matter fields on your local machine is different than that of the following examples. This is a known issue (#452). {{% /note %}}

Adding a New Function

Once you have cloned the Hugo repository, you can create a new function via the following command. Keep the file name lowercase.

hugo new functions/newfunction.md

The archetype for the functions content type is as follows:

{{< readfile file="archetypes/functions.md">}}

Function Required Fields

Let's review some of the fields automatically generated for you using hugo new functions/*:

title: This should be generated in all lowercase when you use hugo new.
linktitle: Use the function's actual casing (e.g., replaceRE rather than replacere).
description: Keep this really short. This is what's used to populate the Functions Quick Reference.
categories: This is populated with 'functions` for future-proofing and portability reasons only. Skip this field.'
tags: Only if you think it will help end users find other related functions
signature: This is a signature/syntax definition for calling the function (e.g., apply SEQUENCE FUNCTION [PARAM...])
workson: Acceptable values include lists,taxonomies, terms, groups, and files
hugoversion: The version of Hugo that will ship with this new function
relatedfuncs: If you can, list some functions you think are related to your new function to help fellow Hugo users.

In the body of you function, expand the short description used in the front matter. Include as many examples as possible, and leverage the Hugo docs code shortcodes. If you are unable to add examples but would like to solicit help from the Hugo community, add needsexample: true to your front matter.

Adding to the Showcase

Once you have cloned the Hugo repository, you can add your Hugo website as a new showcase content file via the following command. Name the markdown file accordingly:

hugo new tutorials/my-hugo-showcase-website.md

The archetype for the showcase content type is as follows:

{{< readfile file="archetypes/showcase.md">}}

Showcase Required Fields

sitelink: the full URL to your website
title: the <title> of your website
description: a general description of your website, preferably < 180 characters.
image: the image (filename only) you want to associate with your website on the Showcase page. The image should be 600px x 400px.

We also appreciate the addition of the remaining fields, specially sourcelink and license if you are willing to share your hard work with the open-source community. tags is optional, but we recommend adding at least 2 to 3 tags to improve discoverability.

Add an Image for the Showcase

We need to create the thumbnail of your website. Give your thumbnail a name like my-hugo-site-name.png. Save it under [docs/static/images/showcase/][].

{{% warning "Showcase Image Size" %}} It's important that the image you use for your showcase submission has the required dimensions of 600px × 400px or the site will not render appropriately. Be sure to optimize your image as a matter of best practice. If you're looking for a quick online optimization tool, check out Compressor. {{% /warning %}}

Adding a New Tutorial

Once you have cloned the Hugo repository, you can create a new tutorial via the following command. Name the markdown file accordingly:

hugo new tutorials/my-new-tutorial.md

The archetype for the tutorials content type is as follows:

{{< readfile file="archetypes/tutorials.md">}}

Adding Code Blocks

Code blocks are crucial for providing examples of Hugo's new features to end users of the Hugo docs. Whenever possible, create examples that you think Hugo users will be able to implement in their own projects.

Standard Syntax

Across all pages on the Hugo docs, the typical triple-back-tick markdown syntax is used. If you do not want to take the extra time to implement the following code block shortcodes, please use standard Github-flavored markdown. The Hugo docs use a version of highlight.js that's been modified for specific Hugo keywords.

Your options for languages are xml/html, go/golang, md/markdown/mkd, handlebars, apache, toml, yaml, json, css, asciidoc, ruby, powershell/ps, scss, sh/zsh/bash/git, http/https, and javascript/js.

```html
<h1>Hello world!</h1>
```

Code Block Shortcodes

The Hugo documentation comes with very robust shortcodes to help you add interactive code snippets.

{{% note %}} With both code and output shortcodes, you must include triple back ticks and language declaration. This was done by design so that the shortcode wrappers were easily added to legacy documentation and will be that much easier to remove if needed in future versions of the Hugo docs. We assume that the triple-back-tick syntax will live longer than our current, pretty shortcode. {{< emo "😄" >}} {{% /note %}}

`code`

code is the code block shortcode you'll use most often. code requires at least a single file named parameter. Here is the signature:

{{%/* code file="smart/file/name/with/path.html" download="download.html" copy="true" */%}}
```language
A whole bunch of coding going on up in here! Boo-yah!
```
{{%/* /code */%}}

These are the arguments passed into code

file: the only required argument. file is needed for styling but also plays an important role in helping users create a mental model around Hugo's directory structure. Visually, this will be displayed as text in the top bar of the text-editor. Always end the value with an extension. For example, instead of ./public/section/, use public/section/index.html. The file extension is used to display the icon.
download: if omitted, this will have no effect on the rendered shortcode. When a value is added to download, it's used as the filename for a downloadable version of the code block.
copy: a copy button is added automatically to all code (i.e., default value = true). If you want to keep the filename and styling of code but don't want to encourage readers to copy the code (e.g., a "Do not do" snippet in a tutorial), pass the copy argument as copy="false".

Example `code` Input

Here is an HTML code block in a case where we want to show the user of the Hugo docs the following:

This type of file could live in layouts/_default.
This snippet is complete enough that it might be worth downloading as a standalone file.

{{%/* code file="layouts/_default/single.html" download="single.html" */%}}
```html
{{ define "main" }}
<main class="main">
    <article class="content">
        <header>
            <h1>{{.Title}}</h1>
            {{with .Params.subtitle}}
            <span class="subtitle">{{.}}</span>
        </header>
        <div class="body-copy">
            {{.Content}}
        </div>
        <aside class="toc">
            {{.TableOfContents}}
        </aside>
    </article>
</main>
{{ end }}
```
{{%/* /code */%}}

Example 'code' Display

The output of this example will render to the Hugo docs as follows:

{{% code file="layouts/_default/single.html" download="single.html" %}}

{{ define "main" }}
<main class="main">
    <article class="content">
        <header>
            <h1>{{.Title}}</h1>
            {{with .Params.subtitle}}
            <span class="subtitle">{{.}}</span>
        </header>
        <div class="body-copy">
            {{.Content}}
        </div>
        <aside class="toc">
            {{.TableOfContents}}
        </aside>
    </article>
</main>
{{ end }}

Cool, right?

Output Code Block

The output shortcode is almost identical to the code shortcode but only takes and requires file. The purpose of output is to show rendered HTML and therefore almost always follows another basic code block or and instance of the code shortcode:

{{%/* output file="post/my-first-post/index.html" */%}}
```html
<h1>This is my First Hugo Blog Post</h1>
<p>I am excited to be using Hugo.</p>
```
{{%/* /output */%}}

The preceding output example will render as follows to the Hugo docs:

<h1>This is my First Hugo Blog Post</h1>
<p>I am excited to be using Hugo.</p>

Blockquotes

Blockquotes can be added to the Hugo documentation using typical Markdown blockquote syntax:

> Without the threat of punishment, there is no joy in flight.

The preceding blockquote will render as follows in the Hugo docs:

Without the threat of punishment, there is no joy in flight.

However, you can add a quick and easy <cite> element (added on the client via JavaScript) by separating your main blockquote and the citation with -:

> Without the threat of punishment, there is no joy in flight. - [Kobo Abe](https://en.wikipedia.org/wiki/K%C5%8Db%C5%8D_Abe)

Which will render as follows on the Hugo docs:

Without the threat of punishment, there is no joy in flight. - Kobo Abe

{{% note "Blockquotes != Admonitions" %}} Previous versions of Hugo documentation used blockquotes to draw attention to text. This is not the intended semantic use of the <blockquote> element. Use blockquotes when quoting. To note or warn your user of specific information, use the admonition shortcodes that follow. {{% /note %}}

Admonitions

Admonitions are common in technical documentation. The most popular is that seen in reStructuredTex Directives. From the SourceForge documentation:

Admonitions are specially marked "topics" that can appear anywhere an ordinary body element can. They contain arbitrary body elements. Typically, an admonition is rendered as an offset block in a document, sometimes outlined or shaded, with a title matching the admonition type. - SourceForge

Both note and warning use a single, optional argument for the admonition title. You can use markdown syntax in this title if you would like. If the title, a positional parameter in quotes is missing, the default behavior of the note and warning shortcodes will be to display the text "Note" and "Warning", respectively.

`note` Admonition

Use the note shortcode when you want to draw attention to information subtly. note is intended to be less of an interruption in content than is warning.

Example `note` Input

{{%/* note "Example Note Admonition" */%}}
Here is a piece of information I would like to draw your **attention** to.
{{%/* /note */%}}

Example `note` Output

{{% note "Example Note Admonition" %}}
Here is a piece of information I would like to draw your **attention** to.
{{% /note %}}

Example `note` Display

{{% note "Example Note Admonition" %}} Here is a piece of information I would like to draw your attention to. {{% /note %}}

`warning` Admonition

Use the warning shortcode when you want to draw the user's attention to something important. A good usage example is for announcing breaking changes for Hugo versions, known bugs, or templating gotchas.

Example `warning` Input

{{%/* warning "Example Warning Admonition" */%}}
This is a warning, which should be reserved for *important* information like breaking changes.
{{%/* /warning */%}}

Example `warning` Output

{{% warning "Example Warning Admonition" %}}
This is a warning, which should be reserved for *important* information like breaking changes.
{{% /warning %}}

Example `warning` Display

{{% warning "Example Warning Admonition" %}} This is a warning, which should be reserved for important information like breaking changes. {{% /warning %}}

Editorial Style Guide

{{% note %}} It's more important to contribute some documentation than no documentation at all. We need your help! {{% /note %}}

The Hugo docs are not especially prescriptive in terms of grammar and usage. We encourage everyone to contribute regardless of your writing style. That said, here are a few gotchas when writing your documentation that, if observed, will create a more consistent documentation experience for the Hugo community:

Front matter and file system are two words; Homepage is one word.
Add a godocref value to the front matter of content files whenever possible. We want to promote Hugo and Golang by demonstrating the inseparable wedding of the two. {{< emo "⭐" >}}

Ask for Code Examples

Sometimes you want to contribute to the docs but don't have enough time to provide lengthy examples. If you want to flag a piece of content as needing more examples, add the following field to your front matter:

needsexamples: true

Please Help! Examples Needed! (WIP)

The preceding needsexamples is used to generate the following list of pages flagged for needing example. The edit link will take you directly to the edit URL for the file in GitHub:

{{% note "Pull Requests and Branches" %}} Similar to contributing to Hugo development, the Hugo team expects you to create a separate branch/fork when you make your generous contributions to the Hugo docs. {{% /note %}}

Be Mindful of Aliases

Use aliases sparingly. The following table shows a list of all the aliases currently being used in the Hugo Docs. Check here first for potential conflicts if you need to use an alias:

16 KiB Raw Blame History Unescape Escape