Commit 197c8775 authored by Jonathan Carter's avatar Jonathan Carter
Browse files

Update content

parent b57f939e
......@@ -14,12 +14,12 @@ googleAnalytics = ""
# copyright = "Released under the MIT license"
# Repository
provider = "Download"
repo_url = "https://desktop.aims.ac.za/download"
#provider = "Download"
#repo_url = "https://desktop.aims.ac.za/download"
version = "2017.1"
logo = "images/logo.png"
favicon = ""
#version = "2017.1"
#logo = "images/logo.png"
#favicon = ""
permalink = "#"
......
---
date: 2016-03-09T19:56:50+01:00
title: Adding content
title: Configuration Guide
weight: 20
---
......@@ -8,58 +8,4 @@ weight: 20
...
## 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 >}}
Coming soon.
......@@ -46,6 +46,4 @@ it up and running.
## Acknowledgements
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.
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.
TODO
---
date: 2016-03-09T19:56:50+01:00
title: Adding content
title: Troubleshooting guide
weight: 20
---
## Download AIMS Desktop
## Troubleshooting guide
...
## 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 >}}
......@@ -18,7 +18,7 @@
<meta property="og:url" content="https://desktop.aims.ac.za/getting-started/">
<meta property="og:title" content="AIMS Desktop">
<meta property="og:image" content="https://desktop.aims.ac.za/images/logo.png">
<meta name="apple-mobile-web-app-title" content="AIMS Desktop">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
......@@ -121,15 +121,11 @@
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<a href="https://desktop.aims.ac.za/download" class="project">
<a href="https://desktop.aims.ac.za/" class="project">
<div class="banner">
<div class="logo">
<img src="https://desktop.aims.ac.za/images/logo.png">
</div>
<div class="name">
<strong>AIMS Desktop <span class="version">2017.1</span></strong>
<strong>AIMS Desktop </strong>
</div>
</div>
......@@ -323,14 +319,14 @@
<div class="next">
<a href="https://desktop.aims.ac.za/configuration/" title="Adding content">
<a href="https://desktop.aims.ac.za/configuration/" title="Configuration Guide">
<span class="direction">
Next
</span>
<div class="page">
<div class="stretch">
<div class="title">
Adding content
Configuration Guide
</div>
</div>
<div class="button button-next" role="button" aria-label="Next">
......
......@@ -18,7 +18,7 @@
<meta property="og:url" content="https://desktop.aims.ac.za/">
<meta property="og:title" content="AIMS Desktop">
<meta property="og:image" content="https://desktop.aims.ac.za/images/logo.png">
<meta name="apple-mobile-web-app-title" content="AIMS Desktop">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
......@@ -124,15 +124,11 @@
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<a href="https://desktop.aims.ac.za/download" class="project">
<a href="https://desktop.aims.ac.za/" class="project">
<div class="banner">
<div class="logo">
<img src="https://desktop.aims.ac.za/images/logo.png">
</div>
<div class="name">
<strong>AIMS Desktop <span class="version">2017.1</span></strong>
<strong>AIMS Desktop </strong>
</div>
</div>
......@@ -340,9 +336,7 @@ it up and running.</p>
<h2 id="acknowledgements">Acknowledgements</h2>
<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>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>
<p>TODO</p>
......@@ -366,14 +360,14 @@ it up and running.</p>
<div class="next">
<a href="https://desktop.aims.ac.za/troubleshooting/" title="Adding content">
<a href="https://desktop.aims.ac.za/troubleshooting/" title="Troubleshooting guide">
<span class="direction">
Next
</span>
<div class="page">
<div class="stretch">
<div class="title">
Adding content
Troubleshooting guide
</div>
</div>
<div class="button button-next" role="button" aria-label="Next">
......@@ -450,6 +444,16 @@ it up and running.</p>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>
}
</script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
......
......@@ -32,7 +32,7 @@
</item>
<item>
<title>Adding content</title>
<title>Configuration Guide</title>
<link>https://desktop.aims.ac.za/configuration/</link>
<pubDate>Wed, 09 Mar 2016 19:56:50 +0100</pubDate>
......@@ -43,127 +43,19 @@
&lt;p&gt;&amp;hellip;&lt;/p&gt;
&lt;h2 id=&#34;hello-world&#34;&gt;Hello world&lt;/h2&gt;
&lt;p&gt;Let&amp;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 &lt;code&gt;&amp;lt;section-name&amp;gt;&lt;/code&gt; with a general term that describes your document in detail.&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-sh&#34;&gt;hugo new &amp;lt;section-name&amp;gt;/filename.md
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Visitors of your website will find the final document under &lt;code&gt;www.example.com/&amp;lt;section-name&amp;gt;/filename/&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;Since it&amp;rsquo;s possible to have multiple content files in the same section I recommend to create at least one &lt;code&gt;index.md&lt;/code&gt; file per section. This ensures that users will find an index page under &lt;code&gt;www.example.com/&amp;lt;section-name&amp;gt;&lt;/code&gt;.&lt;/p&gt;
&lt;h2 id=&#34;homepage&#34;&gt;Homepage&lt;/h2&gt;
&lt;p&gt;To add content to the homepage you need to add a small indicator to the frontmatter of the content file:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-toml&#34;&gt;type: index
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Otherwise the theme will not be able to find the corresponding content file.&lt;/p&gt;
&lt;h2 id=&#34;table-of-contents&#34;&gt;Table of contents&lt;/h2&gt;
&lt;p&gt;You maybe noticed that the menu on the left contains a small table of contents of the current page. All &lt;code&gt;&amp;lt;h2&amp;gt;&lt;/code&gt; tags (&lt;code&gt;## Headline&lt;/code&gt; in Markdown) will be added automatically.&lt;/p&gt;
&lt;h2 id=&#34;admonitions&#34;&gt;Admonitions&lt;/h2&gt;
&lt;p&gt;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 &lt;a href=&#34;http://gohugo.io/extras/shortcodes/&#34;&gt;shortcodes&lt;/a&gt; inside your content:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-go&#34;&gt;{{&amp;lt; note title=&amp;quot;Note&amp;quot; &amp;gt;}}
Nothing to see here, move along.
{{&amp;lt; /note &amp;gt;}}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;This will print the following block:&lt;/p&gt;
&lt;div class=&#34;admonition note&#34;&gt;
&lt;p class=&#34;admonition-title&#34;&gt;Note&lt;/p&gt;
&lt;p&gt;Nothing to see here, move along.&lt;/p&gt;
&lt;/div&gt;
&lt;p&gt;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:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-go&#34;&gt;{{&amp;lt; warning title=&amp;quot;Don&#39;t try this at home&amp;quot; &amp;gt;}}
Nothing to see here, move along.
{{&amp;lt; /warning &amp;gt;}}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;This will print the following block:&lt;/p&gt;
&lt;div class=&#34;admonition warning&#34;&gt;
&lt;p class=&#34;admonition-title&#34;&gt;Don&amp;#39;t try this at home&lt;/p&gt;
&lt;p&gt;Nothing to see here, move along.&lt;/p&gt;
&lt;/div&gt;
&lt;p&gt;Coming soon.&lt;/p&gt;
</description>
</item>
<item>
<title>Adding content</title>
<title>Troubleshooting guide</title>
<link>https://desktop.aims.ac.za/troubleshooting/</link>
<pubDate>Wed, 09 Mar 2016 19:56:50 +0100</pubDate>
<guid>https://desktop.aims.ac.za/troubleshooting/</guid>
<description>
&lt;h2 id=&#34;download-aims-desktop&#34;&gt;Download AIMS Desktop&lt;/h2&gt;
&lt;p&gt;&amp;hellip;&lt;/p&gt;
&lt;h2 id=&#34;hello-world&#34;&gt;Hello world&lt;/h2&gt;
&lt;p&gt;Let&amp;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 &lt;code&gt;&amp;lt;section-name&amp;gt;&lt;/code&gt; with a general term that describes your document in detail.&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-sh&#34;&gt;hugo new &amp;lt;section-name&amp;gt;/filename.md
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Visitors of your website will find the final document under &lt;code&gt;www.example.com/&amp;lt;section-name&amp;gt;/filename/&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;Since it&amp;rsquo;s possible to have multiple content files in the same section I recommend to create at least one &lt;code&gt;index.md&lt;/code&gt; file per section. This ensures that users will find an index page under &lt;code&gt;www.example.com/&amp;lt;section-name&amp;gt;&lt;/code&gt;.&lt;/p&gt;
&lt;h2 id=&#34;homepage&#34;&gt;Homepage&lt;/h2&gt;
&lt;p&gt;To add content to the homepage you need to add a small indicator to the frontmatter of the content file:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-toml&#34;&gt;type: index
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Otherwise the theme will not be able to find the corresponding content file.&lt;/p&gt;
&lt;h2 id=&#34;table-of-contents&#34;&gt;Table of contents&lt;/h2&gt;
&lt;p&gt;You maybe noticed that the menu on the left contains a small table of contents of the current page. All &lt;code&gt;&amp;lt;h2&amp;gt;&lt;/code&gt; tags (&lt;code&gt;## Headline&lt;/code&gt; in Markdown) will be added automatically.&lt;/p&gt;
&lt;h2 id=&#34;admonitions&#34;&gt;Admonitions&lt;/h2&gt;
&lt;p&gt;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 &lt;a href=&#34;http://gohugo.io/extras/shortcodes/&#34;&gt;shortcodes&lt;/a&gt; inside your content:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-go&#34;&gt;{{&amp;lt; note title=&amp;quot;Note&amp;quot; &amp;gt;}}
Nothing to see here, move along.
{{&amp;lt; /note &amp;gt;}}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;This will print the following block:&lt;/p&gt;
&lt;div class=&#34;admonition note&#34;&gt;
&lt;p class=&#34;admonition-title&#34;&gt;Note&lt;/p&gt;
&lt;p&gt;Nothing to see here, move along.&lt;/p&gt;
&lt;/div&gt;
&lt;p&gt;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:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-go&#34;&gt;{{&amp;lt; warning title=&amp;quot;Don&#39;t try this at home&amp;quot; &amp;gt;}}
Nothing to see here, move along.
{{&amp;lt; /warning &amp;gt;}}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;This will print the following block:&lt;/p&gt;
&lt;div class=&#34;admonition warning&#34;&gt;
&lt;p class=&#34;admonition-title&#34;&gt;Don&amp;#39;t try this at home&lt;/p&gt;
&lt;p&gt;Nothing to see here, move along.&lt;/p&gt;
&lt;/div&gt;
&lt;h2 id=&#34;troubleshooting-guide&#34;&gt;Troubleshooting guide&lt;/h2&gt;
</description>
</item>
......@@ -297,9 +189,7 @@ it up and running.&lt;/p&gt;
&lt;h2 id=&#34;acknowledgements&#34;&gt;Acknowledgements&lt;/h2&gt;
&lt;p&gt;Last but not least a big thank you to &lt;a href=&#34;https://github.com/squidfunk&#34;&gt;Martin Donath&lt;/a&gt;. He created the original &lt;a href=&#34;https://github.com/squidfunk/mkdocs-material&#34;&gt;Material theme&lt;/a&gt; for Hugo&amp;rsquo;s companion &lt;a href=&#34;http://www.mkdocs.org/&#34;&gt;MkDocs&lt;/a&gt;. This port wouldn&amp;rsquo;t be possible without him.&lt;/p&gt;
&lt;p&gt;Furthermore, thanks to &lt;a href=&#34;https://gihub.com/spf13&#34;&gt;Steve Francia&lt;/a&gt; for creating Hugo and the &lt;a href=&#34;https://github.com/spf13/hugo/graphs/contributors&#34;&gt;awesome community&lt;/a&gt; around the project.&lt;/p&gt;
&lt;p&gt;TODO&lt;/p&gt;
</description>
</item>
......
......@@ -18,7 +18,7 @@
<meta property="og:url" content="https://desktop.aims.ac.za/license/">
<meta property="og:title" content="AIMS Desktop">
<meta property="og:image" content="https://desktop.aims.ac.za/images/logo.png">
<meta name="apple-mobile-web-app-title" content="AIMS Desktop">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
......@@ -121,15 +121,11 @@
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<a href="https://desktop.aims.ac.za/download" class="project">
<a href="https://desktop.aims.ac.za/" class="project">
<div class="banner">
<div class="logo">
<img src="https://desktop.aims.ac.za/images/logo.png">
</div>
<div class="name">
<strong>AIMS Desktop <span class="version">2017.1</span></strong>
<strong>AIMS Desktop </strong>
</div>
</div>
......
......@@ -18,7 +18,7 @@
<meta property="og:url" content="https://desktop.aims.ac.za/roadmap/">
<meta property="og:title" content="AIMS Desktop">
<meta property="og:image" content="https://desktop.aims.ac.za/images/logo.png">
<meta name="apple-mobile-web-app-title" content="AIMS Desktop">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
......@@ -121,15 +121,11 @@
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<a href="https://desktop.aims.ac.za/download" class="project">
<a href="https://desktop.aims.ac.za/" class="project">
<div class="banner">
<div class="logo">
<img src="https://desktop.aims.ac.za/images/logo.png">
</div>
<div class="name">
<strong>AIMS Desktop <span class="version">2017.1</span></strong>
<strong>AIMS Desktop </strong>
</div>
</div>
......@@ -307,7 +303,7 @@
<nav class="pagination" aria-label="Footer">
<div class="previous">
<a href="https://desktop.aims.ac.za/troubleshooting/" title="Adding content">
<a href="https://desktop.aims.ac.za/troubleshooting/" title="Troubleshooting guide">
<span class="direction">
Previous
</span>
......@@ -317,7 +313,7 @@
</div>
<div class="stretch">
<div class="title">
Adding content
Troubleshooting guide
</div>
</div>
</div>
......
Supports Markdown
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