AIMS Desktop

Getting started

Wed, 12 Apr 2017 00:11:02 +0100

Download AIMS Desktop

Preperation

Installation

Installing AIMS Desktop

Configuration

Options

Adding content

Wed, 09 Mar 2016 19:56:50 +0100

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.

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:

type: index

Otherwise the theme will not be able to find the corresponding content file.

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 inside your content:

{{< note title="Note" >}}
Nothing to see here, move along.
{{< /note >}}

This will print the following block:

Note

Nothing to see here, move along.

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:

{{< warning title="Don't try this at home" >}}
Nothing to see here, move along.
{{< /warning >}}

This will print the following block:

Don't try this at home

Nothing to see here, move along.

Adding content

Wed, 09 Mar 2016 19:56:50 +0100

Download AIMS Desktop

…

Hello world

hugo new <section-name>/filename.md

Visitors of your website will find the final document under www.example.com/<section-name>/filename/.

Homepage

To add content to the homepage you need to add a small indicator to the frontmatter of the content file:

type: index

Otherwise the theme will not be able to find the corresponding content file.

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

{{< note title="Note" >}}
Nothing to see here, move along.
{{< /note >}}

This will print the following block:

Note

Nothing to see here, move along.

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:

{{< warning title="Don't try this at home" >}}
Nothing to see here, move along.
{{< /warning >}}

This will print the following block:

Don't try this at home

Nothing to see here, move along.

Roadmap

Wed, 09 Mar 2016 20:08:11 +0100

Quo vadis? The port of the original Material theme has replicated nearly all of its features. A few are still missing but I’ve good news: the Hugo community is actively working on this issues. Maybe with the next release of Hugo we can abandon this list. Stay tuned.

Localization

Currently, it is possible to collect all strings in a single place for easy customization. However, this only enables you to define all strings in a single language. This approach is quite limiting in terms of localization support. Therefore, I decided to wait for a native integration. This way we can avoid a second setup of all strings in your website.

Keep an eye on #1734.

Search

Beside third-party services, some hacky workarounds and Grunt-/Gulp-based scripts that only require unnecessary dependencies, future versions of Hugo will support the generation of a content index as a core feature.

This approach plays well with this theme since MkDocs does the same.

Keep an eye on #1853.

Contributing

Did you found an bug or you would like to suggest a new feature? I’m open for feedback. Please open a new issue and let me know.

You’re also welcome to contribute with pull requests.

License

Wed, 12 Apr 2017 20:10:46 +0200

AIMS Desktop

AIMS Desktop is free to use for anyone whether it’s for educational, private or commercial use.

It is based on Debian, and made up out of a large collection of software each with their own specific licensing. To read the license for each software package, you can find it in the copyright file under /usr/share/doc for each package.

More information about Debian licensing and its social contract: https://www.debian.org/social_contract

Website powered by Hugo

This website is powered by Hugo, a static website generator written in Go.

https://gohugo.io

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Website theme

This website’s theme is based on “Meterial for Hugo”.

http://themes.gohugo.io/theme/material-docs/

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

AIMS Desktop

Mon, 10 Apr 2017 11:27:13 +0100

Welcome to AIMS Desktop

Please 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 git.aims.ac.za

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.

It is maintained by AIMS (The African Institute for Mathematical Sciences), a pan-African network of centres of excellence enabling Africa’s talented students to become innovators driving the continent’s scientific, educational and economic self-sufficiency.

AIMS Desktop is free for anyone to use for educational, non-profit or commercial purposes. (See: Software Licences for more information)

Features

Debian-based operating system with Gnome desktop environment
Math and Science: Sagemath, Octave, …
Connectity: Firefox, Thunderbird, …
Productivity: LibreOffice Writer, Calc…

See the getting started guide for instructions how to get it up and running.

Acknowledgements

Last but not least a big thank you to Martin Donath. He created the original Material theme for Hugo’s companion MkDocs. This port wouldn’t be possible without him.

Furthermore, thanks to Steve Francia for creating Hugo and the awesome community around the project.

AIMS Desktop

Getting started

Download AIMS Desktop

Preperation

Installation

Installing AIMS Desktop

Configuration

Options

Adding content

Download AIMS Desktop

Hello world

Homepage

Table of contents

Admonitions

Adding content

Download AIMS Desktop

Hello world

Homepage

Table of contents

Admonitions

Roadmap

Localization

Search

Contributing

License

AIMS Desktop

Website powered by Hugo

Website theme

AIMS Desktop

Welcome to AIMS Desktop

Features

Acknowledgements