Getting Started

The following walk-through assumes that you have already installed AutoNOTE onto your own machine. If this is not the case then it is strongly recommended that you first take a look at the Installing AutoNOTE guide.

AutoNOTE Pages

All AutoNOTE pages are represented using markdown files. These files must contain a small predefined header, alongside standard markdown and custom feature instructions to generate the page content.

Page Name and Location

The name of the page (and relative location) will be determined by the name (and location) of the markdown file. For example to produce this page, located at <HOST DOMAIN>/docs/GettingStarted.html, a markdown file was created located at:

<PROJECT ROOT DIRECTORY>/_docs/GettingStarted.md

Page Headers

A ‘liquid’ header must be included in each markdown file in order for AutoNOTE to correctly process the files. For most pages, this header is minimal, requiring only the following parameters:

1
2
3
4
5
---
layout: page
title: Getting Started
use_math: true
---
...

Each of these parameters has a special role, as follows:

layout

This tells AutoNOTE which layout to use when generating the HTML. The default supported options are presented in the next section.

title

The title of the page to be generated. This field is used as the primary header and also in the browser tab.

use_math

Must bet to 'true' if you intend to use latex maths in your page. Otherwise set to 'false' to save on page load times.

Page Layouts