User Guide
Automad ships with an intuitive and clean user interface called the Dashboard. While it is recommended to use the dashboard to edit content and pages, it is also possible to use Automad with just a text editor and a file browser.
The Dashboard
The dashboard provides an intuitive way of managing an Automad website. You can upload files here, add pages and change system settings. A powerful search bar makes it easy to quickly jump to another page or search for content. You can access the dashboard by navigating to https://yoursite.com/dashboard
in your browser. Please also check out the list of available key-combos to make editing more efficient.
Global Settings and Content
Some content such as the site's logo or some theme overrides are considered to be the same on every page. Those settings are basically content without a page context and can be defined in General Data and Files section. It is important to understand that conceptually such settings can be considered to serve as defaults for evey page and can be therefore overriden on page level. It is also the right place to store all media files that are used on more than one page such as a logo image or favicon.
Using a Text Editor
Automad stores content in a human readable form. The file structure of the pages
directory reflects the data structure of your website and URLs are generated based on the directory names. Every page directory must contain a .txt
file. The name of that file represents the template to render the page with. Please check out the included sample content to understand how things are organized. Such a text file basically consists of multiple key: value
pairs, separated by lines only containing one or more hyphens.
title: Portfolio
-
tags: Work, Projects
-
date: 2018-04-29 12:00:00
-
text: ...