• ♡ Sponsor

    User Guide

    #Content #Dashboard

    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.

    More About Pages

    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.

    Read More

    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: ...

    More in User Guide

    • Creating Pages
    • Using Blocks
    • General Data and Files
    • Linking to Files and Pages
    • Resizing Images
    • Key-Combos

    Related

    System

    Automad is designed to be extremely configurable. Managing system settings and running updates can be done by using the browser-based dashboard or a simple text editor and the console.

    System  ⁄
    Language — System

    You can change the language used in the dashboard in the Language tab of the system settings. There are several languages available for the Dashboard. The translations are created automatically. This feature is still in an experimental phase and therefore some translations might ...

    System  ⁄
    Securing the Dashboard — System

    The default URL of Automad's dashboard is /dashboard. To add an extra layer of security to your site you can set a custom URL or disable the dashbaord entirely.

    User Guide  ⁄
    Creating Pages — User 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 ...

    User Guide  ⁄
    Using Blocks — User Guide

    Blocks are little pieces of content like a text paragraph, a header, a gallery, a slideshow or many others. You can even add dynamic content like pagelists, filelists or custom snippets. The block editor provides an intuitive editing experience and enables users to freely compose ...

    User Guide  ⁄
    General Data and Files — User Guide

    Basically general or 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 ...

    User Guide  ⁄
    Linking to Files and Pages — User 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 parameter for a tool or extension represented by a variable. Most of the times you would just use the buttons in the editor ...

    User Guide  ⁄
    Resizing Images — User Guide

    To optimize the speed of your website it is required to use images of an appropriate size. Images can be resized inline or by using the file manager. When using the image selection dialog, it is therefore possible and recommended to add the appropriate dimensions in pixels.

    User Guide  ⁄
    Key-Combos — User Guide

    Key-combos make content editing more efficient. Automad provides a very basic list of key-combos to navigate to pages or save changes.

    Variables  ⁄
    Reserved Variables — Variables

    Some variables have reserved names and are always defined. They can be found on top of the page/shared data section in the dashboard. Reseverd variables can be used like normal page variables.
    • Automad
    • User Guide
    Discuss
    Packages
    Release Notes
    Support
    Terms of Use
      Become a Sponsor
      GitHub
      Twitter
      Facebook
      Instagram
      2013-2022 by Marc Anton Dahmen
    Released under the MIT license
    A faceless machine, creating one's portrait in the internet.
  • Automad
  • Getting Started
  • System
  • User Guide
  • Developer Guide
  • Headless Mode
  • Discuss
  • Packages
  • Creating Pages
  • Using Blocks
  • General Data and Files
  • Linking to Files and Pages
  • Resizing Images
  • Key-Combos