Commit f8a32cda authored by Jonathan Carter's avatar Jonathan Carter
Browse files

add note

parent c3a921f5
---
date: 2016-03-09T19:56:50+01:00
title: Adding content
weight: 20
---
## Download AIMS Desktop
...
## Hello world
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" */>}}
Nothing to see here, move along.
{{</* /note */>}}
```
This will print the following block:
{{< note title="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" */>}}
Nothing to see here, move along.
{{</* /warning */>}}
```
This will print the following block:
{{< warning title="Don't try this at home" >}}
Nothing to see here, move along.
{{< /warning >}}
......@@ -7,6 +7,10 @@ weight: 0
## Welcome to AIMS Desktop
{{< note title="Note" >}}
This website is in its early stages, expect lots of missing content. If you'd like to contribute, you can submit a patch via <a href="git.aims.ac.za">https://git.aims.ac.za/aims-desktop/aims-desktop-website</a>
{{< /note >}}
![AIMS Desktop Picture](/images/screen.png)
AIMS Desktop is a collection of software that allows you to do mathematics and science on your computer easily and efficiently. You need no exising software on your computer, AIMS Desktop installs an entire operating system that you can install standalone, or dual boot with Microsoft Windows or Apple macOS.
......@@ -27,7 +31,6 @@ AIMS Desktop is free for anyone to use for educational, non-profit or commercial
![Debian Logo](/images/projectlogos/debian_64.png)
![Firefox Logo](/images/projectlogos/firefox_64.png)
![Thunderbird Logo](/images/projectlogos/thunderbird_64.png)
![Sagemath Logo](/images/projectlogos/sagemath_64.png)
![Octave Logo](/images/projectlogos/octave_64.png)
![Texstudio Logo](/images/projectlogos/texstudio_64.png)
......
---
date: 2016-03-09T19:56:50+01:00
title: Adding content
weight: 20
---
## Download AIMS Desktop
...
## Hello world
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" */>}}
Nothing to see here, move along.
{{</* /note */>}}
```
This will print the following block:
{{< note title="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" */>}}
Nothing to see here, move along.
{{</* /warning */>}}
```
This will print the following block:
{{< warning title="Don't try this at home" >}}
Nothing to see here, move along.
{{< /warning >}}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment