Commit 4fd0c830 authored by Jonathan Carter's avatar Jonathan Carter
Browse files

Update site

parent be2aeca7
baseurl = "https://example.org/"
baseurl = "https://desktop.aims.ac.za/"
languageCode = "en-us"
title = "Material Docs"
title = "AIMS Desktop"
theme = "hugo-material-docs"
metadataformat = "yaml"
canonifyurls = true
......@@ -14,10 +14,10 @@ googleAnalytics = ""
copyright = "Released under the MIT license"
# Repository
provider = "GitHub"
repo_url = "https://github.com/digitalcraftsman/hugo-material-docs"
provider = "Download"
repo_url = "https://desktop.aims.ac.za/download"
version = "1.0.0"
version = "2017.1"
logo = "images/logo.png"
favicon = ""
......@@ -31,8 +31,8 @@ googleAnalytics = ""
highlight_css = ""
[params.palette]
primary = "red"
accent = "teal"
primary = "#fc0000"
accent = "blue"
[params.font]
text = "Ubuntu"
......@@ -41,12 +41,12 @@ googleAnalytics = ""
[social]
twitter = ""
github = "digitalcraftsman"
email = "hello@email.com"
github = ""
email = "aims-tech@aims.ac.za"
[[menu.main]]
name = "Material"
name = "Welcome"
url = "/"
weight = 0
......
---
date: 2016-03-08T21:07:13+01:00
title: Material for Hugo
date: 2017-04-10T11:27:13+01:00
title: AIMS Desktop
type: index
weight: 0
---
## Beautiful documentation
## Welcome to AIMS Desktop
Material is a theme for [Hugo](https://gohugo.io), a fast and flexible static site generator. It is built using Google's [material design](https://www.google.com/design/spec/material-design/introduction.html)
guidelines, fully responsive, optimized for touch and pointer devices as well
as all sorts of screen sizes.
AIMS Desktop is.... (collection of free software, math + science, debian based, etc)
![Material Screenshot](/images/screen.png)
Material is very lightweight – it is built from scratch using Javascript and
CSS that weighs less than 30kb (minified, gzipped and excluding Google Fonts
and Analytics). Yet, it is highly customizable and degrades gracefully in older
browsers.
It is maintained by AIMS (pan african... etc)
## Quick start
Install with `git`:
![Material Screenshot](/images/screen.png)
```sh
git clone git@github.com:digitalcraftsman/hugo-material-docs.git themes/hugo-material-docs
```
AIMS Desktop is free for anyone to use for educational, non-profit or commercial purposes. (See: Software Licences)
## Features
- Beautiful, readable and very user-friendly design based on Google's material
design guidelines, packed in a full responsive template with a well-defined
and [easily customizable color palette]({{< relref "getting-started/index.md#changing-the-color-palette" >}}), great typography, as well as a
beautiful search interface and footer.
-
- Well-tested and optimized Javascript and CSS including a cross-browser
fixed/sticky header, a drawer that even works without Javascript using
the [checkbox hack](http://tutorialzine.com/2015/08/quick-tip-css-only-dropdowns-with-the-checkbox-hack/) with fallbacks, responsive tables that scroll when
the screen is too small and well-defined print styles.
-
- Extra configuration options like a [project logo]({{< relref "getting-started/index.md#adding-a-logo" >}}), links to the authors
[GitHub and Twitter accounts]({{< relref "getting-started/index.md#adding-a-github-and-twitter-account" >}}) and display of the amount of stars the
project has on GitHub.
-
- Web application capability on iOS – when the page is saved to the homescreen,
it behaves and looks like a native application.
-
See the [getting started guide]({{< relref "getting-started/index.md" >}}) for instructions how to get
it up and running.
......
<!DOCTYPE html>
<html class="no-js">
<head lang="en-us">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Adding content - AIMS Desktop</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="description" content="A material design theme for documentations.">
<link rel="canonical" href="https://desktop.aims.ac.za/adding-content/">
<meta name="author" content="Digitalcraftsman">
<meta property="og:url" content="https://desktop.aims.ac.za/adding-content/">
<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">
<link rel="shortcut icon" type="image/x-icon" href="https://desktop.aims.ac.za/images/favicon.ico">
<link rel="icon" type="image/x-icon" href="https://desktop.aims.ac.za/images/favicon.ico">
<style>
@font-face {
font-family: 'Icon';
src: url('https://desktop.aims.ac.za/fonts/icon.eot');
src: url('https://desktop.aims.ac.za/fonts/icon.eot')
format('embedded-opentype'),
url('https://desktop.aims.ac.za/fonts/icon.woff')
format('woff'),
url('https://desktop.aims.ac.za/fonts/icon.ttf')
format('truetype'),
url('https://desktop.aims.ac.za/fonts/icon.svg')
format('svg');
font-weight: normal;
font-style: normal;
}
</style>
<link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/application.css">
<link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/temporary.css">
<link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/palettes.css">
<link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/highlight/highlight.css">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu&#43;Mono">
<style>
body, input {
font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
}
pre, code {
font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
}
</style>
<script src="https://desktop.aims.ac.za/javascripts/modernizr.js"></script>
</head>
<body class="palette-primary-red palette-accent-teal">
<div class="backdrop">
<div class="backdrop-paper"></div>
</div>
<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>
<header class="header">
<nav aria-label="Header">
<div class="bar default">
<div class="button button-menu" role="button" aria-label="Menu">
<label class="toggle-button icon icon-menu" for="toggle-drawer">
<span></span>
</label>
</div>
<div class="stretch">
<div class="title">
Adding content
</div>
</div>
</div>
<div class="bar search">
<div class="button button-close" role="button" aria-label="Close">
<label class="toggle-button icon icon-back" for="toggle-search"></label>
</div>
<div class="stretch">
<div class="field">
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
</div>
</div>
<div class="button button-reset" role="button" aria-label="Search">
<button class="toggle-button icon icon-close" id="reset-search"></button>
</div>
</div>
</nav>
</header>
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<a href="https://github.com/digitalcraftsman/hugo-material-docs" 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">1.0.0</span></strong>
<br>
digitalcraftsman/hugo-material-docs
</div>
</div>
</a>
<div class="scrollable">
<div class="wrapper">
<ul class="repo">
<li class="repo-download">
<a href="https://github.com/digitalcraftsman/hugo-material-docs/archive/master.zip" target="_blank" title="Download" data-action="download">
<i class="icon icon-download"></i> Download
</a>
</li>
<li class="repo-stars">
<a href="https://github.com/digitalcraftsman/hugo-material-docs/stargazers" target="_blank" title="Stargazers" data-action="star">
<i class="icon icon-star"></i> Stars
<span class="count">&ndash;</span>
</a>
</li>
</ul>
<hr>
<div class="toc">
<ul>
<li>
<a title="Test 1" href="https://desktop.aims.ac.za/">
Test 1
</a>
</li>
<li>
<a title="Getting started" href="https://desktop.aims.ac.za/getting-started/">
Getting started
</a>
</li>
<li>
<a class="current" title="Adding content" href="https://desktop.aims.ac.za/adding-content/">
Adding content
</a>
<ul id="scrollspy">
</ul>
</li>
<li>
<a title="Roadmap" href="https://desktop.aims.ac.za/roadmap/">
Roadmap
</a>
</li>
<li>
<a title="License" href="https://desktop.aims.ac.za/license/">
License
</a>
</li>
</ul>
<hr>
<span class="section">The author</span>
<ul>
<li>
<a href="mailto:aims-tech@aims.ac.za" title="Email of aims-tech@aims.ac.za">
Contact via email
</a>
</li>
</ul>
</div>
</div>
</div>
</nav>
</div>
<article class="article">
<div class="wrapper">
<h1>Adding content </h1>
<h2 id="hello-world">Hello world</h2>
<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>
<h2 id="homepage">Homepage</h2>
<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>
<h2 id="admonitions">Admonitions</h2>
<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>
<pre><code class="language-go">{{&lt; note title=&quot;Note&quot; &gt;}}
Nothing to see here, move along.
{{&lt; /note &gt;}}
</code></pre>
<p>This will print the following block:</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Nothing to see here, move along.</p>
</div>
<p>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:</p>
<pre><code class="language-go">{{&lt; warning title=&quot;Don't try this at home&quot; &gt;}}
Nothing to see here, move along.
{{&lt; /warning &gt;}}
</code></pre>
<p>This will print the following block:</p>
<div class="admonition warning">
<p class="admonition-title">Don&#39;t try this at home</p>
<p>Nothing to see here, move along.</p>
</div>
<aside class="copyright" role="note">
&copy; 2017 Released under the MIT license &ndash;
Documentation built with
<a href="https://www.gohugo.io" target="_blank">Hugo</a>
using the
<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
</aside>
<footer class="footer">
<nav class="pagination" aria-label="Footer">
<div class="previous">
<a href="https://desktop.aims.ac.za/getting-started/" title="Getting started">
<span class="direction">
Previous
</span>
<div class="page">
<div class="button button-previous" role="button" aria-label="Previous">
<i class="icon icon-back"></i>
</div>
<div class="stretch">
<div class="title">
Getting started
</div>
</div>
</div>
</a>
</div>
<div class="next">
<a href="https://desktop.aims.ac.za/roadmap/" title="Roadmap">
<span class="direction">
Next
</span>
<div class="page">
<div class="stretch">
<div class="title">
Roadmap
</div>
</div>
<div class="button button-next" role="button" aria-label="Next">
<i class="icon icon-forward"></i>
</div>
</div>
</a>
</div>
</nav>
</footer>
</div>
</article>
<div class="results" role="status" aria-live="polite">
<div class="scrollable">
<div class="wrapper">
<div class="meta"></div>
<div class="list"></div>
</div>
</div>
</div>
</main>
<script>
var base_url = 'https:\/\/desktop.aims.ac.za\/';
var repo_id = 'digitalcraftsman\/hugo-material-docs';
</script>
<script src="https://desktop.aims.ac.za/javascripts/application.js"></script>
<script>
/* Add headers to scrollspy */
var headers = document.getElementsByTagName("h2");
var scrollspy = document.getElementById('scrollspy');
if(scrollspy) {
if(headers.length > 0) {
for(var i = 0; i < headers.length; i++) {
var li = document.createElement("li");
li.setAttribute("class", "anchor");
var a = document.createElement("a");
a.setAttribute("href", "#" + headers[i].id);
a.setAttribute("title", headers[i].innerHTML);
a.innerHTML = headers[i].innerHTML;
li.appendChild(a)
scrollspy.appendChild(li);
}
} else {
scrollspy.parentElement.removeChild(scrollspy)
}
/* Add permanent link next to the headers */
var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");
for(var i = 0; i < headers.length; i++) {
var a = document.createElement("a");
a.setAttribute("class", "headerlink");
a.setAttribute("href", "#" + headers[i].id);
a.setAttribute("title", "Permanent link")
a.innerHTML = "#";
headers[i].appendChild(a);
}
}
</script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>
<?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>
&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;