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
• Lightweight interactivity using Alpine.js
• Development server with auto-reload
• Git-based auto-deployment feature via webhooks

Note: Parsedown 1.7.4 requires PHP <8.1

Gettings started

Setup

yarn install

Run

yarn dev

The website is now served at http://localhost:3000/.

Build

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:

# A long, secret and HTML-safe string
DEPLOY_SECRET=<YOUR_DEPLOYMENT_SECRET>
# Optional: Whitelist IP addresses, e.g. only accept webhooks from localhost
DEPLOY_WEBHOOK_IPS=127.0.0.1,

Each request to /deploy/<YOUR_DEPLOYMENT_SECRET> 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:

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/<YOUR_DEPLOYMENT_SECRET> 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