-
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
Open
http://yoursite.com/dashboardin your browser to access the dashboard.The dashboard is 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/dashboardin your browser. Please also check out the list of available key-combos to make editing more efficient.
Using a Text Editor
Automad stores content in a human readable form. The file structure of the
pagesdirectory reflects the data structure of your website and URLs are generated based on the directory names. Every page directory must contain a.txtfile. 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.
The structure of a text file is basically number ofkey: valuepairs like this:title: Portfolio - tags: Work, Projects - date: 2018-04-29 12:00:00 - text: ...
Related Items
System
Automad is designed to be extremely configurable. Managing system settings and running updates can be done by using the web-based dashboard or a simple text editor and the command line interface.System
In case you manage your site locally and then deploy the full site to your web server using a ssh session or similar, you can disable the dashboard on the public site entirely by editing the config/config.json as follows:
Disabling the Dashboard - SystemUser Guide
Managing pages using the dashboard is quite self-explanatory. Pages can be added by hitting the + button on the right side of the navigation bar on top. To navigate to an existing page, you can browse the site tree on the left sidebar or start typing some letters of the page title into the search ...
Managing Pages - User GuideUser Guide
Basically shared content is just content without a page context. Usually that is the place to store site logos and content which is identical on all pages across your website. You can also choose your globally used theme here. Conceptually, shared content can be seen as the default content for all ...
Shared Content - User GuideUser Guide
There are multiple places where you need to specify URLs to pages or paths to media files within your content. That may be a link within your markdown or a paramter for a tool or extension represented by a variable. In this regard there are some rules to be observed.
Linking to Files And Pages - User GuideUser Guide
Key-combos make content editing more efficient. Automad provides a very basic list of key-combos to navigate to pages or save changes.
Key-Combos - User GuideVariables
Some variables have reserved names and are always defined. The can be found on top of the page/shared data section in the dashboard. Reseverd variables can be used like normal page variables.
Reserved Variables - Variables