Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/philipptrenz/md-cms
A minimal flat-file CMS, consisting of Markdown files and a very slim PHP core
https://github.com/philipptrenz/md-cms
alpine alpinejs cms flat-file flat-file-cms php tailwind tailwindcss website website-template
Last synced: 5 days ago
JSON representation
A minimal flat-file CMS, consisting of Markdown files and a very slim PHP core
- Host: GitHub
- URL: https://github.com/philipptrenz/md-cms
- Owner: philipptrenz
- License: mit
- Created: 2022-12-15T16:12:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-16T11:35:55.000Z (over 1 year ago)
- Last Synced: 2023-03-10T19:59:12.202Z (over 1 year ago)
- Topics: alpine, alpinejs, cms, flat-file, flat-file-cms, php, tailwind, tailwindcss, website, website-template
- Language: PHP
- Homepage:
- Size: 119 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# md-cms
Sometimes it doesn't take much: a fancy main page, divided into a few components for clarity and ... oh yes, the legal pages. But later having to edit imprint and privacy policy in HTML? Not fun. - that's how md-cms came into being.
*md-cms is a minimal flat-file CMS, consisting of Markdown files and a very slim PHP core.*
Features:
* Dynamic rendering of Markdown files via HTML template
* Utility-first styling with [tailwindcss](http://tailwindcss.com)
* Lightweight interactivity using [Alpine.js](https://alpinejs.dev)
* Development server with auto-reload
* Git-based auto-deployment feature via webhooks
**Note:** [Parsedown 1.7.4](https://github.com/erusev/parsedown) requires PHP <8.1
## Gettings started
### Setup
```bash
yarn install
```
### Run
```bash
yarn dev
```
The website is now served at [http://localhost:3000/](http://localhost:3000/).
### Build
```bash
yarn build
```
## Auto-Deployment
### Enable the feature
The auto-deployment feature enables webhook actions, e.g. triggered by GitHub, to pull latest changes from a git repository onto the web server.
Therefore, create a `.env` file in document root:
```env
# A long, secret and HTML-safe string
DEPLOY_SECRET=
# Optional: Whitelist IP addresses, e.g. only accept webhooks from localhost
DEPLOY_WEBHOOK_IPS=127.0.0.1,
```
Each request to `/deploy/` will now trigger `git pull`, `git submodule sync`, followed by `git submodule update`.
### Add deployment key
**Note:** Make sure the following SSH configuration belongs to the user used by the webserver, like `web`, e.g. by changing user with `sudo su web`.
1. Create an SSH key on the server as deployment key:
```sh
ssh-keygen -t ed25519 -a 420 -f ~/.ssh/your.project.ed25519 -C "Deployment key for your.project"
```
2. Add a SSH config to `~/.ssh/config`, e.g. for GitHub:
```
Host your_project
Hostname github.com
IdentityFile ~/.ssh/your.project.ed25519
IdentitiesOnly yes
```
3. Add SSH public key as deployment key to git platform
4. Clone the repository at the server using the generated deployment key:
```
git clone git@your_project:user/your.project.git'
```
5. Add a webhook to your git platform, specifying the `/deploy/` endpoint.
6. Sit back and enjoy.
## You need more?
I know some projects grow. And at some point, the customer might even want a backend with login and everything. For you too?
Then check out Kirby: Also a flat-file CMS with similar folder structure, fancy and fully customizable backend, plugins and much more.
https://getkirby.com