beenull/AntCMS
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated the readme

Browse source
This commit is contained in:
Belle Aerni 2023-01-07 01:44:18 -08:00
parent 2fc2775720
commit 4dc49dd861
2 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
readme.md
View file

@ -1,5 +1,7 @@
# AntCMS
[![PHPStan](https://github.com/BelleNottelling/AntCMS/actions/workflows/phpstan.yml/badge.svg)](https://github.com/BelleNottelling/AntCMS/actions/workflows/phpstan.yml)
A tiny and fast CMS system for static websites.
## What is AntCMS
@ -13,3 +15,15 @@ AntCMS is extremely fast, thanks to its simple backend and caching. It can rende
### How does it work?
AntCMS is very straightforward to use. First, you need a template in HTML with special elements for AntCMS. Then, you write your content using [markdown](https://www.markdownguide.org/getting-started/), a popular way to format plain text documents. AntCMS converts the markdown to HTML, integrates it into the template, and sends it to the viewer. Even without caching, this process is quick, but AntCMS also has caching capabilities to further improve rendering times.
### Themeing with AntCMS
AntCMS stores it's themes under `/Themes`. Each theme is extremely simple, just a simple page layout template and if needed, assets associated with that theme.
A theme may also have a `/Themes/Example/Assets` folder, these files can be accessed directly from the server. Files stored in any other location will be inaccessible otherwise.
For example, this is what the default theme folder structure looks like:
- `/Themes`
- `/Default`
- `default_layout.html`
Changing the theme is easy, simply edit `Config.yaml` and set the `activeTheme` to match the folder name of your custom theme.

12
src/Content/subfolder/readme.md
View file

@ -19,3 +19,15 @@ AntCMS is extremely fast, thanks to its simple backend and caching. It can rende
### How does it work?
AntCMS is very straightforward to use. First, you need a template in HTML with special elements for AntCMS. Then, you write your content using [markdown](https://www.markdownguide.org/getting-started/), a popular way to format plain text documents. AntCMS converts the markdown to HTML, integrates it into the template, and sends it to the viewer. Even without caching, this process is quick, but AntCMS also has caching capabilities to further improve rendering times.
### Themeing with AntCMS
AntCMS stores it's themes under `/Themes`. Each theme is extremely simple, just a simple page layout template and if needed, assets associated with that theme.
A theme may also have a `/Themes/Example/Assets` folder, these files can be accessed directly from the server. Files stored in any other location will be inaccessible otherwise.
For example, this is what the default theme folder structure looks like:
- `/Themes`
- `/Default`
- `default_layout.html`
Changing the theme is easy, simply edit `Config.yaml` and set the `activeTheme` to match the folder name of your custom theme.