Let's create our first content file for your documentation. Open a terminal and add the following command for each new file you want to add. Replace `<section-name>` with a general term that describes your document in detail.
```sh
hugo new <section-name>/filename.md
```
Visitors of your website will find the final document under `www.example.com/<section-name>/filename/`.
Since it's possible to have multiple content files in the same section I recommend to create at least one `index.md` file per section. This ensures that users will find an index page under `www.example.com/<section-name>`.
## Homepage
To add content to the homepage you need to add a small indicator to the frontmatter of the content file:
```toml
type:index
```
Otherwise the theme will not be able to find the corresponding content file.
## Table of contents
You maybe noticed that the menu on the left contains a small table of contents of the current page. All `<h2>` tags (`## Headline` in Markdown) will be added automatically.
## Admonitions
Admonition is a handy feature that adds block-styled side content to your documentation, for example hints, notes or warnings. It can be enabled by using the corresponding [shortcodes](http://gohugo.io/extras/shortcodes/) inside your content:
```go
{{</* note title="Note" */>}}
Nothingtoseehere,movealong.
{{</* /note */>}}
```
This will print the following block:
{{<notetitle="Note">}}
Nothing to see here, move along.
{{</note>}}
The shortcode adds a neutral color for the note class and a red color for the warning class. You can also add a custom title:
```go
{{</* warning title="Don't try this at home" */>}}
Last but not least a big thank you to [Martin Donath](https://github.com/squidfunk). He created the original [Material theme](https://github.com/squidfunk/mkdocs-material) for Hugo's companion [MkDocs](http://www.mkdocs.org/). This port wouldn't be possible without him.
TODO
Furthermore, thanks to [Steve Francia](https://gihub.com/spf13) for creating Hugo and the [awesome community](https://github.com/spf13/hugo/graphs/contributors) around the project.
Let's create our first content file for your documentation. Open a terminal and add the following command for each new file you want to add. Replace `<section-name>` with a general term that describes your document in detail.
```sh
hugo new <section-name>/filename.md
```
Visitors of your website will find the final document under `www.example.com/<section-name>/filename/`.
Since it's possible to have multiple content files in the same section I recommend to create at least one `index.md` file per section. This ensures that users will find an index page under `www.example.com/<section-name>`.
## Homepage
To add content to the homepage you need to add a small indicator to the frontmatter of the content file:
```toml
type:index
```
Otherwise the theme will not be able to find the corresponding content file.
## Table of contents
You maybe noticed that the menu on the left contains a small table of contents of the current page. All `<h2>` tags (`## Headline` in Markdown) will be added automatically.
## Admonitions
Admonition is a handy feature that adds block-styled side content to your documentation, for example hints, notes or warnings. It can be enabled by using the corresponding [shortcodes](http://gohugo.io/extras/shortcodes/) inside your content:
```go
{{</* note title="Note" */>}}
Nothingtoseehere,movealong.
{{</* /note */>}}
```
This will print the following block:
{{<notetitle="Note">}}
Nothing to see here, move along.
{{</note>}}
The shortcode adds a neutral color for the note class and a red color for the warning class. You can also add a custom title:
```go
{{</* warning title="Don't try this at home" */>}}
<p>Last but not least a big thank you to <ahref="https://github.com/squidfunk">Martin Donath</a>. He created the original <ahref="https://github.com/squidfunk/mkdocs-material">Material theme</a> for Hugo’s companion <ahref="http://www.mkdocs.org/">MkDocs</a>. This port wouldn’t be possible without him.</p>
<p>TODO</p>
<p>Furthermore, thanks to <ahref="https://gihub.com/spf13">Steve Francia</a> for creating Hugo and the <ahref="https://github.com/spf13/hugo/graphs/contributors">awesome community</a> around the project.</p>
<p>Let&rsquo;s create our first content file for your documentation. Open a terminal and add the following command for each new file you want to add. Replace <code>&lt;section-name&gt;</code> with a general term that describes your document in detail.</p>
<pre><code class="language-sh">hugo new &lt;section-name&gt;/filename.md
</code></pre>
<p>Visitors of your website will find the final document under <code>www.example.com/&lt;section-name&gt;/filename/</code>.</p>
<p>Since it&rsquo;s possible to have multiple content files in the same section I recommend to create at least one <code>index.md</code> file per section. This ensures that users will find an index page under <code>www.example.com/&lt;section-name&gt;</code>.</p>
<p>To add content to the homepage you need to add a small indicator to the frontmatter of the content file:</p>
<pre><code class="language-toml">type: index
</code></pre>
<p>Otherwise the theme will not be able to find the corresponding content file.</p>
<h2 id="table-of-contents">Table of contents</h2>
<p>You maybe noticed that the menu on the left contains a small table of contents of the current page. All <code>&lt;h2&gt;</code> tags (<code>## Headline</code> in Markdown) will be added automatically.</p>
<p>Admonition is a handy feature that adds block-styled side content to your documentation, for example hints, notes or warnings. It can be enabled by using the corresponding <a href="http://gohugo.io/extras/shortcodes/">shortcodes</a> inside your content:</p>
<p>Let&rsquo;s create our first content file for your documentation. Open a terminal and add the following command for each new file you want to add. Replace <code>&lt;section-name&gt;</code> with a general term that describes your document in detail.</p>
<pre><code class="language-sh">hugo new &lt;section-name&gt;/filename.md
</code></pre>
<p>Visitors of your website will find the final document under <code>www.example.com/&lt;section-name&gt;/filename/</code>.</p>
<p>Since it&rsquo;s possible to have multiple content files in the same section I recommend to create at least one <code>index.md</code> file per section. This ensures that users will find an index page under <code>www.example.com/&lt;section-name&gt;</code>.</p>
<p>To add content to the homepage you need to add a small indicator to the frontmatter of the content file:</p>
<pre><code class="language-toml">type: index
</code></pre>
<p>Otherwise the theme will not be able to find the corresponding content file.</p>
<h2 id="table-of-contents">Table of contents</h2>
<p>You maybe noticed that the menu on the left contains a small table of contents of the current page. All <code>&lt;h2&gt;</code> tags (<code>## Headline</code> in Markdown) will be added automatically.</p>
<p>Admonition is a handy feature that adds block-styled side content to your documentation, for example hints, notes or warnings. It can be enabled by using the corresponding <a href="http://gohugo.io/extras/shortcodes/">shortcodes</a> inside your content:</p>
<p>Last but not least a big thank you to <a href="https://github.com/squidfunk">Martin Donath</a>. He created the original <a href="https://github.com/squidfunk/mkdocs-material">Material theme</a> for Hugo&rsquo;s companion <a href="http://www.mkdocs.org/">MkDocs</a>. This port wouldn&rsquo;t be possible without him.</p>
<p>TODO</p>
<p>Furthermore, thanks to <a href="https://gihub.com/spf13">Steve Francia</a> for creating Hugo and the <a href="https://github.com/spf13/hugo/graphs/contributors">awesome community</a> around the project.</p>