github.com/google/cloudprober@v0.11.3/docs/themes/hugo-material-docs/exampleSite/content/adding-content/index.md (about)

     1  ---
     2  date: 2016-03-09T19:56:50+01:00
     3  title: Adding content
     4  weight: 20
     5  ---
     6  
     7  ## Hello world
     8  
     9  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.
    10  
    11  ```sh
    12  hugo new <section-name>/filename.md
    13  ```
    14  
    15  Visitors of your website will find the final document under `www.example.com/<section-name>/filename/`.
    16  
    17  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>`.
    18  
    19  ## Homepage
    20  
    21  To add content to the homepage you need to add a small indicator to the frontmatter of the content file:
    22  
    23  ```toml
    24  type: index
    25  ```
    26  
    27  Otherwise the theme will not be able to find the corresponding content file.
    28  
    29  ## Table of contents
    30  
    31  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.
    32  
    33  ## Admonitions
    34  
    35  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:
    36  
    37  ```go
    38  {{</* note title="Note" */>}}
    39  Nothing to see here, move along.
    40  {{</* /note */>}}
    41  ```
    42  
    43  This will print the following block:
    44  
    45  {{< note title="Note" >}}
    46  Nothing to see here, move along.
    47  {{< /note >}}
    48  
    49  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:
    50  
    51  ```go
    52  {{</* warning title="Don't try this at home" */>}}
    53  Nothing to see here, move along.
    54  {{</* /warning */>}}
    55  ```
    56  
    57  This will print the following block:
    58  
    59  {{< warning title="Don't try this at home" >}}
    60  Nothing to see here, move along.
    61  {{< /warning >}}