README

Important

Please use the new and modern theme starter kit instead of this repository in order to get started with a new theme.

You can use this package as a package skeleton for new Automad themes. It includes all files to get you started with your own themes quickly. However there is only one single template file with a simple tree menu. While its functionality is reduced to a minimum, it covers most aspects of theme developing regarding the Automad template language. The beautiful Bulma CSS framework is used to style the template and therefore this package doesn't include any CSS or JS files.

• Included Templates
• Development Workflow
  • The Local Package
  • Create a Git Repository
  • Register Your Package
• Cheat Sheets

Included Templates

This package contains these simplified templates that only serve demonstrational purposes:

1. The page.php template represents a basic page with a navbar, a content area and a sidebar with menu.
2. The pagelist.php template contains a filterable and sortable pagelist that can be used as a skeleton for blogs or portfolios.
3. The session.phptemplate demonstrates the usage of session variables and the set function.
4. The images.php template provides a minimal example of how to build a gallery template.

☝️ To see those templates in action while playing around just apply them to any page in your installation!

Development Workflow

This very detailed in-depth guide describes step by step the workflow of setting up and publish a new theme using Composer. You can probaly skip some of the points in case you have been working already with Composer in the past.

☝️ This guide assumes you're familiar with Visual Code Studio and working on a system with a Bash shell or similar — like macOS or Linux. However, it is of course possible to do the same on a Windows PC — just slightly different.

The Local Package

1. It's a good practice to start developing a new package outside of the Automad packages directory. Therefore change to some directory outside of Automad where you want to develop your new theme. Let's assume you want to put your package into a directory called dev within your home folder.

   cd ~/dev
   

2. Create new skeleton theme in your dev directory using Composer.

   composer create-project automad/theme-skeleton my-theme
   

3. Change to the new theme directory and edit the composer.json and theme.json files. VS Code is used here as the editor. At least change the vendor and theme name.

   cd my-theme
   code composer.json
   

   Also edit the name in theme.json.

   code theme.json
   

4. Now change to your Automad root directory. For example ~/Sites/automad-site.

   cd ~/Sites/automad-site
   

5. Edit the composer.json file of the Automad installation.

   code composer.json
   

   Add the following snippet to Automad's composer file (note the path to your package).

   {
       ...
       "repositories": [
           {
               "type": "path",
               "url": "~/dev/my-theme"
           }
       ],
       ...
   }
   

6. Still in the Automad directory run the following Composer command.

   composer require my-vendor/my-theme:@dev
   

   Now your theme is available in Automad and you can start developing your templates. After all the setup it's now time to create a repository for your theme.

Create a Git Repository

When developing is done, it's time to publish your work.

1. Init new Git repository and commit files.

   cd ~/dev/my-theme
   git init
   git add .
   git commit -m "First commit"
   

2. Create a first release tag for your finished theme following the semantic versioning scheme.

   git tag -a 1.0.0 -m "my version 1.0.0"
   

3. Create a new repository on GitHub.

4. Now, add its URL as a remote to your local repository and push changes. When creating a repository, the URL will be printed on the GitHub page.

   git remote add origin /remote/URL/of/your/new/repo
   git push -u origin master
   

Register Your Package

Now it's time to submit your theme package to Packagist. After succseffuly registering it, it will automatically show up in the package browser.

Cheat Sheets

In case you prefer to start developing a theme or extension without reading the full documention, the Cheat Sheets are a good point to start.