https://github.com/reactivematter/tunnelcms
Simplest markdown cms
https://github.com/reactivematter/tunnelcms
cms markdown php
Last synced: 12 months ago
JSON representation
Simplest markdown cms
- Host: GitHub
- URL: https://github.com/reactivematter/tunnelcms
- Owner: ReactiveMatter
- License: mit
- Created: 2024-09-07T22:46:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T14:27:34.000Z (almost 2 years ago)
- Last Synced: 2024-10-16T18:59:52.985Z (over 1 year ago)
- Topics: cms, markdown, php
- Language: PHP
- Homepage: https://reactivematter.github.io/tunnel-cms
- Size: 103 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Tunnel CMS
v2.0.0 (Updated on 15.03.25)
Tunnel CMS is the simplest markdown CMS. It parses markdown files and outputs html in real time whenever necessary. However, not every request requires parsing, as Tunnel CMS builds the HTML files and store in cache. Until, the underlying content of the markdown files is changes, the cached HTML is served.
## 🛠️ Installation
Download the `tunnel` folder along with the `.htaccess` file from the [Github directory](https://github.com/ReactiveMatter/tunnelcms) `https://github.com/ReactiveMatter/tunnelcms`. Place them in the root of your website, and that's it!
Tunnel CMS will render your markdown files dynamically, so that you can focus on writing.
Requirements: PHP 8 or higher.
## 📝 YAML frontmatter
Tunnel CMS parses YAML front matter from the markdown files and serializes them in the `$page` variable. This can be used by the layout to display content.
Some useful page properties:
| Property | Description |
| --- | --- |
| `layout` | Sets the layout for the file which will be used for rendering HTML. |
| `category` | Sets the category for the file. One page can have only one category.|
| `tags` | Tags for the file |
## 🖥️ Template and layout
The layout files from `template` folder are used to render html content. The layout can be set in YAML front matter in `layout` property. `default.php` is used when no layout is set.
The `title` property can be set for the page title. If not set, the first heading in the markdown file is set as title.
If a layout requires the list of all parsed files, the function `get_all_pages()` can be called. It returns an array of pages. Each element will have properties set for that page.
## 🏷️ Tags
Files can be assigned tags using the front matter property `tags`. In addition to this, Tunnel CMS assigns tags if hash tags are given in the file (e.g. `#tag1`).
## 💾 Cache
Tunnel CMS stores the rendered HTML files and associated metadata in `cache` folder. Whenever a file is requested for the first time, a build processes in initiated. In the build process, front matter is processed, the HTML content is generated and saved as HTML files in `cache`.
The file `content` and `template` directory hashes, and file _mtime_ are saved in metadata (a json file).
As and when the file modified time changes, the build process is again initiated.
## ⚙️ Config
Config variable are stored in `config.php`. They are site wide variables used for the build process, and can also be used by the templates.
| Config variable | Description |
| --- | --- |
| `$site['title']` | Site title |
| `$site['ext']` | The file extensions which will be parsed |
| `$site['default_layout']` | The default layout for parsing. If set to `page`, `template/page.php` will be used.|
| `$site['date_format']` | The PHP date display format. To be used in layouts.|
| `$site['cache']` | Whether to enable caching.|
| `$site['plugins']` | The list of enabled plugins (filenames are to be added to this array.|
Custom variable can be defined in config file, which can be used in the template files.
## 🔗 Links
By default markdown links are relative to http root (`/about`). However, to make it relative to Tunnel CMS directory use `$/about`.
## 🛠️ Workings
The detailed process and control flow is provided in [workings](workings).
## 🔌 Plugins
Starting from version 2, Tunnel CMS can be extended or improved by plugins.
Plugins are php files in `core/plugins` directory. To enable a plugin, the name of the plugin file must be added to `$site['plugins']` array in `config.php`.
Plugins file are included autmatically at the start of the process, by `plugin_manager.php`. Plugins can hook functions at 4 places:
- start: It is called before the render process is initiated. The $site and $requests parameters are available.
- before_render: It is called before HTML is being rendered but after $page is build.
- after_render: It is called after HTML is rendered but before caching.
- end: It is called after the render process is complete.
Example of adding hook:
```
add_hook('start','remove_old_cache');
```
## 📑 Content
All markdown content is to be put in `content` folder with desired directory structure. The directory structre and file names are used as url.
The content can be managed by FTP, SFTP, SSH or by PHP based filemanagers (like [tinyfilemanager](https://tinyfilemanager.github.io/).)
## 📜 License
This project is licensed under the MIT License.
## Credits
Tunnel CMS is developed by ReactiveMatter.
Github repo: https://github.com/ReactiveMatter/
Github blog: https://reactivematter.github.io/