Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shaack/reboot-cms
A flat file, Markdown CMS in PHP with blocks structure.
https://github.com/shaack/reboot-cms
bootstrap cms flat-file-cms markdown markdown-cms no-database php
Last synced: about 6 hours ago
JSON representation
A flat file, Markdown CMS in PHP with blocks structure.
- Host: GitHub
- URL: https://github.com/shaack/reboot-cms
- Owner: shaack
- License: mit
- Created: 2018-11-06T07:53:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-08T11:32:59.000Z (7 months ago)
- Last Synced: 2024-05-09T09:40:03.442Z (6 months ago)
- Topics: bootstrap, cms, flat-file-cms, markdown, markdown-cms, no-database, php
- Language: PHP
- Homepage:
- Size: 4.66 MB
- Stars: 31
- Watchers: 7
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reboot CMS
A flat file, Markdown CMS in PHP, inspired by [Pico](http://picocms.org), [Redaxo](https://redaxo.org/) and
[Craft CMS](https://craftcms.com/).
Reboot CMS is a minimal CMS without needing a database, but with the support of `Blocks`.
## Why another CMS?
I developed Reboot CMS because I didn't find a CMS that works with flat markdown files but allows easy use of blocks.
Reboot CMS is very small and the pages are delivered extremely fast. My homepage [shaack.com](https://shaack.com), which
was build with Reboot CMS has a
[PageSpeed Insights performance scoring of 100](https://pagespeed.web.dev/report?url=https%3A%2F%2Fshaack.com%2F).
## Websites using Reboot CMS
- [The Reboot CMS demo page](https://shaack.com/projekte/reboot-cms/)
- [shaack.com](https://shaack.com)
- [wukies.de](https://wukies.de)
- [chesscoin032.com](https://chesscoin032.com)
## Install
Download the [Reboot CMS repository](https://github.com/shaack/reboot-cms) and install it in your web root.
This should work out of the box.
Then (**important**), **set the Admin password in `/local/.htpasswd`**
## Documentation
### Page
Folder: `/site/pages`
A `Page` can be a **flat Markdown** file, can contain **Blocks** or also can be a **PHP** file.
Pages are auto-routed on web-requests:
- `index.md` or `index.php` will be shown on requesting `/`
- `NAME.md` or `NAME.php` will be shown on requesting `/NAME`
- `FOLDER/index.md` (or .php) will be shown on requesting `/FOLDER`
- `FOLDER/NAME.md` (or .php) will be shown on requesting `/FOLDER/NAME`
Example for a Markdown `Page` with `Blocks`:
```markdown
---
title: Reboot CMS
description: Reboot CMS is a flat file CMS, with the support of blocks.
author: Stefan Haack (shaack.com)
---
# Reboot CMS
A flat file, markdown CMS with blocks
---
The main idea is, to have a **minimal CMS** without needing a database, but with the support of blocks.
---
[Learn more](documentation)
## The text-image block
The gray block above was a jumbotron block. This one is a text-image block, it contains two parts. Parts are separated
by `---`.
---
## Configure blocks in the block comment
The text-image block can also display the image to the left.
---
>
### the
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint
occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est.
---
### three-colums
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute
iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
---
### block
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
aliqua.
```
This `Page` contains 3 `Block` types, "jumbotron", "text-image" and "three-columns". It will render to this:
Blocks can be configured in the block comment. With this configuration, the `text-image`
block allows to display the image to the left side in desktop view.
Markdown files without blocks will render to a flat Markdown page like in every other flat file CMS.
You can define metadata for the page on top of the file in `YAML Front Matter` syntax.
### Block
Folder: `/site/blocks`
A `Block` describes how a block is rendered. Blocks are written in PHP.
The code for the "text-image" `Block` which was used in the page above, looks like this:
```php
getConfig()["image-position"];
?>
">
= $block->xpath("/*[part(1)]") ?>
"
alt="= $block->xpath("//img[part(2)]/@alt") ?>"
title="= $block->xpath("//img[part(2)]/@title") ?>"/>
```
Elements in the markdown are queried and used as values for the block. The query syntax
is [Xpath](https://devhints.io/xpath) with the addition of the `part(n)` function.
Another example, the "jumbotron" `Block`:
```php
= $block->xpath("/h1[part(1)]/text()") ?>
= $block->xpath("/p[part(1)]/text()") ?>
= $block->xpath("/*[part(2)]") ?>
"
role="button">= $block->xpath("//a[part(3)]/text()") ?>
```
## Admin interface
You find the admin interface unter `/admin`. The default login is
- user: admin
- pwd: change_me
You can and should change the admin password in `local/.htpasswd` with
```sh
cd local
htpasswd .htpasswd admin
```
In the admin interface you can edit markdown pages and set the site configuration in which the navigation structure is
defined.
### Edit the startpage
### Edit a flat markdown page
### Edit the site configuration
In the site configuration, you can store global values of the site, like the navigation structure or the content of header elements. The site configuration is written in YAML.
