Skip to content

Lightweight documentation website generator written in PHP

License

Notifications You must be signed in to change notification settings

eugabrielsilva/butterdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ButterDocs

License PHP Version

Create tasty documentations

ButterDocs is a lightweight documentation website generator written in PHP. Simply create your Markdown files and ButterDocs will do the rest for you, creating a beautiful and responsive website with your docs.

Features

  • Fast and lightweight
  • No static HTML files
  • Support for multiple documentation versions
  • Theme customization with automatic light/dark mode
  • Syntax highlighting support
  • Automatic routing
  • Automatic menu generation
  • Support for search in files
  • Responsive layout
  • Supports flavored Markdown and Markdown Extra
  • Supports direct editing on GitHub
  • Large compatibility with all basic hosting providers

Getting started

Explore the documentation to know how to start using ButterDocs to create tasty documentations.

The documentation website itself was made with ButterDocs, so this is a great example on how to get started. The docs source code is bundled within the project.

Dependencies

Credits

ButterDocs is currently being developed by Gabriel Silva.