38e51166c3
* Start implementing APCu caching * Fix tests * Now make PHPStan happy :) * Fix tests * Also enable the APCu extension in the tests * Set maxlife to 7 days & clear with cron * Implement a more correct way to clear the cache * Also mention the APCu caching in the readme
70 lines
4.7 KiB
Markdown
70 lines
4.7 KiB
Markdown
# AntCMS
|
|
|
|
[](https://github.com/AntCMS-org/AntCMS/actions/workflows/phpstan.yml)
|
|
[](https://github.com/AntCMS-org/AntCMS/actions/workflows/unittests.yml)
|
|
|
|
A tiny and fast CMS system for static websites.
|
|
|
|
## What is AntCMS?
|
|
|
|
AntCMS is a lightweight CMS system designed for simplicity, speed, and small size. It is a flat-file CMS, meaning it lacks advanced features but benefits from improved speed and reduced complexity.
|
|
|
|
### How fast is AntCMS?
|
|
|
|
AntCMS is designed for speed, with a simple backend and caching capabilities that allow it to quickly render and deliver pages to users in milliseconds. This speed is further enhanced by the use of Tailwind CSS in the default theme, which is only 25KB.
|
|
Our unit tests also ensure that rendering markdown content takes less than 0.015 seconds, as demonstrated by the following recent results: `Markdown rendering speed with cache: 0.000289 VS without: 0.003414`.
|
|
|
|
### How does it work?
|
|
|
|
Using AntCMS is simple. First, you need an HTML template with special elements for AntCMS. Then, you can write your content using the popular [markdown](https://www.markdownguide.org/cheat-sheet/) formatting syntax. AntCMS will convert the markdown to HTML, integrate it into the template, and send it to the viewer. This process is already quick, but AntCMS also has caching capabilities that can further improve rendering times.
|
|
|
|
AntCMS will also automatically leverage the APCu extension for caching, which helps to further improve your website's response time.
|
|
|
|
### Theming with AntCMS
|
|
|
|
AntCMS stores its themes in the `/Themes` directory. Each theme consists of a simple page layout template. A theme may also have an `/Assets` folder within its directory, which can be accessed directly from the server. Any files stored outside of this folder will be inaccessible.
|
|
|
|
Here is an example of the default theme folder structure:
|
|
|
|
- `/Themes`
|
|
- `/Default`
|
|
- `/Templates`
|
|
- `default.html.twig`
|
|
- `nav.html.twig`
|
|
- `/Assets`
|
|
- `tailwind.css`
|
|
|
|
To change the active theme, simply edit `Config.yaml` and set the `activeTheme` option to match the folder name of your custom theme.
|
|
|
|
### Configuring AntCMS
|
|
|
|
AntCMS stores its configuration in the human-readable "yaml" file format. The main configuration files are `Config.yaml`, `Pages.yaml`, and `Users.yaml`. These files will be automatically generated by AntCMS if they do not exist.
|
|
|
|
#### Options in `Config/Config.yaml`
|
|
|
|
- `siteInfo:`
|
|
- `siteTitle: AntCMS` - This configuration sets the title of your AntCMS website.
|
|
- `forceHTTPS: true` - Set to 'true' by default, enables HTTPs redirection.
|
|
- `activeTheme: Default` - Sets what theme AntCMS should use. should match the folder name of the theme you want to use.
|
|
- `enableCache: true` - Enables or disables file caching in AntCMS.
|
|
- `debug: true`- Enabled or disables debug mode.
|
|
- `baseURL: antcms.example.com/` - Used to set the baseURL for your AntCMS instance, without the protocol. This will be automatically generated for you, but can be changed if needed.
|
|
|
|
#### Options in `Config/Pages.yaml`
|
|
|
|
The `Pages.yaml` file holds a list of your pages. This file is automatically generated if it doesn't exist. At the moment, AntCMS doesn't automatically regenerate this for you, so for new content to appear you will need to delete the `Pages.yaml` file.
|
|
The order of which files are stored inside of the `Pages.yaml` file dictates what order they will be displayed in the browser window.
|
|
Here's what the `Pages.yaml` file looks like:
|
|
|
|
- `pageTitle: 'Hello World'` - This defines what the title of the page is in the navbar.
|
|
- `fullPagePath: /antcms.example.com/public_html/Content/index.md` - This defines the full path to your page, as PHP would use to access it.
|
|
- `functionalPagePath: /index.md` - This is the actual path you would use to access the page from online. Ex: `antcms.example.com/index.php`
|
|
- `showInNav: true` - If you'd like to hide a page from the navbar, set this to false and it will be hidden.
|
|
|
|
#### The Admin Plugin
|
|
|
|
AntCMS has a very simple admin plugin that you can access it by visiting `antcms.example.com/admin`.
|
|
It will then require you to authenticate using your AntCMS credentials and from there will give you a few simple actions such as editing your config, a page, or regenerating the page list.
|
|
The admin plugin also features a live preview of the content you are creating, but it's important to note that the preview doesn't support all of the markdown syntax that AntCMS does, such as emojis.
|
|
|
|
Note: when editing the config, if you 'save' it and it didn't update, this means you made an error in the config file and AntCMS prevented the file from being saved.
|