PhpDev.App
marcantondahmen/automad

marcantondahmen/automad

Stars: 499

Forks: 34

Pull Requests: 8

Issues: 76

Watchers: 15

Last Updated: 2023-09-01 16:26:08

#automad #cms #flat-file #template-language

A flat-file content management system and template engine

License: MIT License

Languages: PHP, JavaScript, Hack, Shell, Less, TypeScript

https://automad.org

Automad

A flat-file content management system and template engine

Tag Language Size License Twitter

👋 Version 2

Currently, the development of version 2 is very, very active. New features and fixes are implemented on a daily basis. The version 2 update will essentially be a full rewrite of the entire application, including the backend, frontend, standard theme and blocks. The goal is to also include as many open feature requests and resolve as many open issues as possible until the day of the release. Existing websites using version 1 as well as existing extensions, except for some minor execptions, will continue to work just fine and will be compatible with version 2. Minor breaking changes will be communicated with the relase notes.

The new dashboard will be entirely written in TypeScript and will no longer have jQuery and UIkit as dependencies. The new backend will require at least PHP 8.0 or newer.

Please note that this is an open-source project that is free to use and the maintainer spends a substatial portion of his free time, weekends and nights in order to finish the release as soon as possible. That said, there is no fix release date yet. It is done whenever it is done. In the meantime you can safely start new website using version 1 and migrate to version 2 afterwards.

Please also consider the above when opening new issues in order to not waste anybody's time.

And as always, pull-request will continue to be ignored as stated below.

In case you want to help, please give this repository a star, consider a small donation or take a look a these other possible ways to contribute to the project.

Mockup

Installation

Automad can be installed using Docker, Composer or manually.

Composer

The fastest way to get Automad up and running is to use Composer.

composer create-project automad/automad .

Follow this guide to finish the installation and get started quickly.

Docker

It is also possible to run Automad in a Docker container including Nginx and PHP 8.

docker run -dp 80:80 -v ./app:/app --name mysite automad/automad

The first time you run the image, a new user account for the Automad dashboard will be created automatically. The account details will be logged by the running container. You can show these logs using the following command:

docker logs mysite

Your can now navigate to localhost to view your new site.

Manual Download

Alternatively Automad can also be installed manually.

Documentation

Take a look at the documentation to get started with using Automad or to learn how to develop themes and extensions. In case you are interested in using plain PHP in your themes or to develop more complex extensions, check out Automad's API reference.

Packages

Visit the Automad package browser to get free themes and extensions for your Automad site.

Community

Join the community, ask questions or start a discussion on the Automad discussion platform.

Contributing

In case you are interested in contributing, the following types of contribution are welcome:

However, I do not exclude at this point using parts of Automad's source in future projects under different licenses. In order to avoid having to ask anybody for permission when doing so, I will not accept any contributions to this repository. Please understand that pull requests will therefore be ignored.

Text Editors Plugins

To make the development of themes more efficient, plugins providing syntax highlighting and snippets for Automad's template language are available for the following editors:

© 2013-2023 Marc Anton Dahmen
Released under the MIT license

OPEN ISSUES

See all

RELEASES

See all