Updated readme, moved minimum PHP ver to 8.0

This commit is contained in:
Belle Aerni 2023-01-10 18:50:10 -08:00
parent 506e66c0ae
commit 016103f7cd
4 changed files with 16 additions and 9 deletions

View file

@ -6,7 +6,7 @@
"minimum-stability": "stable",
"require": {
"symfony/yaml": "^6.0",
"php": ">=7.4",
"php": ">=8.0",
"league/commonmark": "^2.3",
"elgigi/commonmark-emoji": "^2.0",
"twig/twig": "^3.5",

4
composer.lock generated
View file

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "7f7fedbff2c529f6168337f46cef5ed3",
"content-hash": "4fc85db32453a70401719d5162e9be02",
"packages": [
{
"name": "dflydev/dot-access-data",
@ -2849,7 +2849,7 @@
"prefer-stable": false,
"prefer-lowest": false,
"platform": {
"php": ">=7.4"
"php": ">=8.0"
},
"platform-dev": [],
"plugin-api-version": "2.3.0"

View file

@ -10,6 +10,11 @@ location /robots.txt {
try_files $uri =204;
}
location /sitemap.xml {
# Allow access to the sitemap.xml file
try_files $uri =204;
}
location / {
try_files $uri $uri/ /index.php?$args;
}

View file

@ -1,6 +1,6 @@
# AntCMS
[![PHPStan](https://github.com/BelleNottelling/AntCMS/actions/workflows/phpstan.yml/badge.svg)](https://github.com/BelleNottelling/AntCMS/actions/workflows/phpstan.yml)
[![PHPStan](https://github.com/AntCMS-org/AntCMS/actions/workflows/phpstan.yml/badge.svg)](https://github.com/AntCMS-org/AntCMS/actions/workflows/phpstan.yml)
[![Unit Tests](https://github.com/AntCMS-org/AntCMS/actions/workflows/unittests.yml/badge.svg)](https://github.com/AntCMS-org/AntCMS/actions/workflows/unittests.yml)
A tiny and fast CMS system for static websites.
@ -11,7 +11,7 @@ AntCMS is a lightweight CMS system designed for simplicity, speed, and small siz
### 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 20KB.
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`.
@ -37,9 +37,9 @@ To change the active theme, simply edit `config.yaml` and set the `activeTheme`
### Configuring AntCMS
AntCMS stores its configuration in the human-readable yaml file format. The main configuration files are config.yaml and pages.yaml. These files will be automatically generated by AntCMS if they do not exist.
AntCMS stores its configuration in the human-readable "yaml" file format. The main configuration files are `config.yaml` and `pages.yaml`. These files will be automatically generated by AntCMS if they do not exist.
#### Options in `config.yaml`
#### Options in `Config/config.yaml`
- `SiteInfo:`
- `siteTitle: AntCMS` - This configuration sets the title of your AntCMS website.
@ -53,9 +53,10 @@ AntCMS stores its configuration in the human-readable yaml file format. The main
- `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 `pages.yml`
#### 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.
@ -65,7 +66,8 @@ Here's what the `pages.yaml` file looks like:
#### The Admin Plugin
AntCMS has a very simple admin plugin. Once you set your password in your `config.yaml`, you can access it by visiting `antcms.example.com/plugin/admin`.
AntCMS has a very simple admin plugin. Once you set your password in your `Config/config.yaml`, you can access it by visiting `antcms.example.com/plugin/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.