Skip to content

Latest commit

 

History

History
48 lines (43 loc) · 1.19 KB

README.md

File metadata and controls

48 lines (43 loc) · 1.19 KB
Raw

Doky CMS PHP

A PHP CMS that syncs the documentation written to and from a git repository.

The basic idea of this CMS is that the documentation written to it will be available both in the development repository as markdown files but then also be in a database. This way the documentation can be written to in a web interface and then be synced to the repository.

Tasks/Roadmap

First Basic Version

  • Synchronizer
    • Git
      • Cloning repository
      • Pulling changes
      • Pushing changes
      • Creating detailed commit messages
      • Webhook for updates
      • Uploading to specific branch
      • Serving from specific directory
  • Backend
    • Compression of images
    • Index of all docs
    • Serialization of docs into markdown
  • CMS
    • Roles
      • Role-based permission system
    • Users
      • Author name in doc
      • Co-authoring
    • Editor
      • Markdown editor
      • Meta
        • Basic Key-Value pairs
        • YAML
  • Frontend
    • Search
      • Advanced search per word
      • Priority sorting with doc meta
    • Keybinds
      • Open search overlay
    • Mobile support
  • API
    • Documentation
      • Markdown
      • Meta data