auvernhatinternet/markflat

A markdown flat file CMS

v1.4.1 2025-03-21 13:24 UTC

Requires

• php: >=8.2
• league/commonmark: ^2.6
• symfony/asset: ^7.2
• symfony/framework-bundle: ^7.2
• symfony/runtime: ^7.2
• symfony/translation: ^7.2
• symfony/twig-bundle: ^7.2
• symfony/yaml: ^7.2
• twig/extra-bundle: ^3.20
• twig/markdown-extra: ^3.20
• vlucas/phpdotenv: ^5.6

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.72
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.0
• symfony/stopwatch: ^7.2
• symfony/test-pack: ^1.0

MIT

README

🚀 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

# 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 directory:

• 📚 Introduction
• 🏁 Getting Started
• 📝 Content Management
• 🎨 Theming System
• 🗺️ Maps Integration
• ⚙️ Configuration
• 🤝 Contributing

🌟 Showcase

🤝 Contributing

We love your input! Check out our Contributing Guide to get started.

• 🐛 Report bugs by opening an issue
• 💡 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
• Styled with TailwindCSS
• Maps powered by Leaflet
• Icons by Heroicons

Made with ❤️ by the MarkFlat team