About

Minerva

Minerva is a lightweight Markdown-based documentation and publishing system built in PHP. It supports browsing, editing, and rendering .md files, and is designed with flexibility, simplicity, and self-hosting in mind.

🚀 Features

• Clean and responsive Bootstrap 5 layout
• Parses Markdown using Parsedown
• Directory-based content structure
• Admin editing via edit.php
• Navigation with breadcrumb and file tree
• Optional support for:
  • Previous/next navigation between files
  • Private/public book access
  • Git-based content versioning
• Ideal for publishing documentation, teaching materials, or personal notes

📁 Project Structure

/
├── content/                # Markdown content files (separate repo or submodule)
├── index.php              # Frontend viewer
├── edit.php               # Admin interface for editing Markdown
├── users.json             # Optional user system (for auth)
├── Parsedown.php          # Markdown parser
├── .gitignore
└── README.md

🔄 Development Ideas

• Support for "next" and "previous" buttons across directories
• Move/delete files from the admin interface
• Toggle visibility of books (public/private)
• Tagging and metadata for markdown files
• Search/indexing

📄 License

MIT License.

Third-Party Libraries

This project includes Parsedown, a Markdown parser for PHP released under the MIT License.

👋 Credits

Minerva was created by Kyle Vanderburg and inspired by lightweight publishing systems like WriteBook.

Markdown parsing via Parsedown.