Skip to content

efekurucay-archive/Content-Management-System--CMS--by-eferoam

Repository files navigation

eferoam CMS - Minimalist Documentation Platform

A lightweight, file-based documentation CMS built with PHP and modern frontend technologies. Perfect for creating and managing technical documentation, wikis, and knowledge bases.

Live demo: https://docs.efekurucay.com

eferoam CMS

📸 Screenshots

Light Mode Dark Mode

✨ Features

  • Markdown Support: Full Markdown syntax support with live preview
  • File-Based: No database required, all content stored as Markdown files
  • Modern UI: Clean interface with Tailwind CSS
  • Dark Mode: Automatic and manual dark mode support
  • Code Highlighting: Syntax highlighting for multiple languages
  • PDF Export: Export documentation pages as PDF
  • Search: Real-time content search functionality
  • Mobile Responsive: Optimized for all devices
  • Admin Panel: User-friendly content management interface

🚀 Quick Start

  1. Clone the repository
git clone https://github.com/efekurucay/Content-Management-System--CMS--by-eferoam.git
cd Content-Management-System--CMS--by-eferoam
  1. Configure your web server to point to the project directory

  2. Set up admin credentials in config.php:

define('ADMIN_USERNAME', 'your_username');
define('ADMIN_PASSWORD', password_hash('your_password', PASSWORD_DEFAULT));
  1. Ensure write permissions for these directories:
chmod 755 content/
chmod 755 cache/
  1. Access the admin panel at /docs/?route=login

💻 Requirements

  • PHP 8.0 or higher
  • Apache/Nginx web server
  • mod_rewrite enabled
  • Write permissions for content and cache directories

🛠️ Technology Stack

  • Backend: PHP 8+
  • Frontend: Tailwind CSS, Alpine.js
  • Syntax Highlighting: Prism.js
  • Icons: Font Awesome
  • PDF Generation: DomPDF

📝 Usage

Creating Content

  1. Log in to the admin panel
  2. Click the "+" button to create a new document
  3. Write your content in Markdown format
  4. Use the live preview to check formatting
  5. Save your document

Markdown Features

  • Headers (H1-H6)
  • Lists (ordered and unordered)
  • Code blocks with syntax highlighting
  • Tables
  • Links and images
  • Blockquotes
  • And more!

🔒 Security Features

  • Session-based authentication
  • Password hashing
  • XSS protection
  • CSRF protection
  • Secure file handling
  • Input sanitization

🎨 Customization

Themes

Modify the Tailwind configuration in index.php to customize:

  • Colors
  • Typography
  • Spacing
  • Breakpoints
  • Dark mode preferences

Templates

Create custom templates in the templates/ directory for:

  • Documentation pages
  • Meeting notes
  • API documentation
  • Release notes

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📞 Support

For support, please create an issue in the GitHub repository or contact the maintainer.

contact@efekurucay.com

efekurucay.com

About

eferoam CMS - Minimalist Documentation Platform

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages