index.xml 4.02 KB
Newer Older
Jonathan Carter's avatar
Jonathan Carter committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Adding-contents on AIMS Desktop</title>
    <link>https://desktop.aims.ac.za/adding-content/index.xml</link>
    <description>Recent content in Adding-contents on AIMS Desktop</description>
    <generator>Hugo -- gohugo.io</generator>
    <language>en-us</language>
    <copyright>Released under the MIT license</copyright>
    <lastBuildDate>Wed, 09 Mar 2016 19:56:50 +0100</lastBuildDate>
    <atom:link href="https://desktop.aims.ac.za/adding-content/index.xml" rel="self" type="application/rss+xml" />
    
    <item>
      <title>Adding content</title>
      <link>https://desktop.aims.ac.za/adding-content/</link>
      <pubDate>Wed, 09 Mar 2016 19:56:50 +0100</pubDate>
      
      <guid>https://desktop.aims.ac.za/adding-content/</guid>
      <description>

Jonathan Carter's avatar
Jonathan Carter committed
21
22
23
24
&lt;h2 id=&#34;download-aims-desktop&#34;&gt;Download AIMS Desktop&lt;/h2&gt;

&lt;p&gt;&amp;hellip;&lt;/p&gt;

Jonathan Carter's avatar
Jonathan Carter committed
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
&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;
</description>
    </item>
    
  </channel>
</rss>