An open API service indexing awesome lists of open source software.

https://github.com/auvernhatinternet/markflat

MarkFlat is a simple and light Flat File CMS using Markdown to edit pages and posts. Based on Symfony and TailwindCSS
https://github.com/auvernhatinternet/markflat

bundle flat-file-cms framework php symfony tailwindcss themes

Last synced: about 1 year ago
JSON representation

MarkFlat is a simple and light Flat File CMS using Markdown to edit pages and posts. Based on Symfony and TailwindCSS

Awesome Lists containing this project

README

          

# 🌟 MarkFlat CMS

[![PHP Tests](https://github.com/auvernhatinternet/markflat/actions/workflows/php.yml/badge.svg)](https://github.com/auvernhatinternet/markflat/actions/workflows/php.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PHP Version](https://img.shields.io/badge/PHP-8.3%2B-blue.svg)](https://www.php.net)
[![Symfony Version](https://img.shields.io/badge/Symfony-7.0%2B-purple.svg)](https://symfony.com)

> πŸš€ A modern, file-based CMS built with Symfony and TailwindCSS. Create beautiful websites without the complexity of a database!

## 🎯 Why MarkFlat?

MarkFlat is designed for developers and content creators who want a **simple**, **fast**, and **modern** CMS without the overhead of a database. Write your content in Markdown, style it with TailwindCSS, and deploy it anywhere!

### ✨ Key Features

- πŸ“ **File-based**: No database required - all content lives in Markdown files
- 🎨 **Modern Stack**: Built with Symfony 7+ and TailwindCSS
- πŸ—ΊοΈ **Interactive Maps**: Built-in Leaflet.js integration
- 🎯 **Simple & Fast**: Lightweight and blazing fast by design
- πŸ” **Full-text Search**: Find content instantly
- πŸ“± **Responsive**: Beautiful on all devices
- πŸŒ™ **Dark Mode**: Built-in dark mode support
- 🏷️ **Tag System**: Organize content effortlessly

## πŸš€ Quick Start

```bash
# Clone the repository
git clone https://github.com/auvernhatinternet/markflat.git
cd markflat

# Using Docker (recommended)
docker build -t markflat-app .
docker run -dit --name markflat-app -p 8080:80 -v "$PWD":/var/www/html markflat-app

# Or manual installation
composer install
npm install
npm run build
```

## πŸ“– Documentation

Detailed documentation is available in the [/doc](./doc) directory:

- πŸ“š [Introduction](./doc/introduction.md)
- 🏁 [Getting Started](./doc/getting-started.md)
- πŸ“ [Content Management](./doc/content-management.md)
- 🎨 [Theming System](./doc/theming.md)
- πŸ—ΊοΈ [Maps Integration](./doc/maps.md)
- βš™οΈ [Configuration](./doc/configuration.md)
- 🀝 [Contributing](./doc/contributing.md)

## 🌟 Showcase

![MarkFlat Screenshot](https://raw.githubusercontent.com/auvernhatinternet/markflat/main/doc/assets/screenshot.png)

## 🀝 Contributing

We love your input! Check out our [Contributing Guide](./doc/contributing.md) to get started.

- πŸ› Report bugs by [opening an issue](https://github.com/auvernhatinternet/markflat/issues/new)
- πŸ’‘ Propose new features
- πŸ“ Improve documentation
- πŸ”§ Submit pull requests

## πŸ’– Support

- ⭐ Star this repo
- πŸ“’ Share with your friends

## πŸ“„ License

MarkFlat is open-source software licensed under the MIT license.

## πŸ™ Acknowledgments

- Built with [Symfony](https://symfony.com)
- Styled with [TailwindCSS](https://tailwindcss.com)
- Maps powered by [Leaflet](https://leafletjs.com)
- Icons by [Heroicons](https://heroicons.com)

---


Made with ❀️ by the MarkFlat team