Improved readme
This commit is contained in:
Belle Aerni
parent
55e20d3f25
commit
ff68feeae6
2 changed files with 18 additions and 18 deletions
18
readme.md
18
readme.md
|
|
@ -11,18 +11,19 @@ AntCMS is a lightweight CMS system designed for simplicity, speed, and small siz
|
|||
|
||||
### How fast is AntCMS?
|
||||
|
||||
AntCMS is extremely fast, thanks to its simple backend and caching. It can render and deliver pages to end users in milliseconds.
|
||||
This speed is made even faster by the fact that our default theme is created using Tailwind and 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 20KB.
|
||||
|
||||
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?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Theming with AntCMS
|
||||
|
||||
AntCMS stores its themes under `/Themes`. Each theme is extremely simple, just a simple page layout template.
|
||||
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:
|
||||
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`
|
||||
|
|
@ -32,12 +33,11 @@ For example, this is what the default theme folder structure looks like:
|
|||
- `/Assets`
|
||||
- `tailwind.css`
|
||||
|
||||
Changing the theme is easy, simply edit `config.yaml` and set the `activeTheme` to match the folder name of your custom theme.
|
||||
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 it's configuration in the human readable `yaml` file format. The two files are `config.yaml` and `pages.yaml`.
|
||||
Both files will automatically be generated by AntCMS if they don't 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`
|
||||
|
||||
|
|
|
|||
|
|
@ -14,18 +14,19 @@ AntCMS is a lightweight CMS system designed for simplicity, speed, and small siz
|
|||
|
||||
### How fast is AntCMS?
|
||||
|
||||
AntCMS is extremely fast, thanks to its simple backend and caching. It can render and deliver pages to end users in milliseconds.
|
||||
This speed is made even faster by the fact that our default theme is created using Tailwind and 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 20KB.
|
||||
|
||||
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?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Theming with AntCMS
|
||||
|
||||
AntCMS stores its themes under `/Themes`. Each theme is extremely simple, just a simple page layout template.
|
||||
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:
|
||||
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`
|
||||
|
|
@ -35,12 +36,11 @@ For example, this is what the default theme folder structure looks like:
|
|||
- `/Assets`
|
||||
- `tailwind.css`
|
||||
|
||||
Changing the theme is easy, simply edit `config.yaml` and set the `activeTheme` to match the folder name of your custom theme.
|
||||
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 it's configuration in the human readable `yaml` file format. The two files are `config.yaml` and `pages.yaml`.
|
||||
Both files will automatically be generated by AntCMS if they don't 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`
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue