# butterdocs

**Repository Path**: wfdaj/butterdocs

## Basic Information

- **Project Name**: butterdocs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-06
- **Last Updated**: 2024-03-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
    <a href="https://github.com/eugabrielsilva/butterdocs" target="_blank"><img src="https://i.imgur.com/3SrqkTl.png" alt="ButterDocs" width="200"/></a>
</p>

<p align="center">
    <a href="https://github.com/eugabrielsilva/butterdocs" target="_blank"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
    <a href="https://github.com/eugabrielsilva/butterdocs" target="_blank"><img src="https://img.shields.io/badge/php-%5E7.4%7C%5E8.0-blue" alt="PHP Version"></a>
</p>

## 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](https://eugabrielsilva.tk/butterdocs) 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
- [Parsedown](https://parsedown.org)
- [highlight.js](https://highlightjs.org)
- [Bootstrap](https://getbootstrap.com)
- [Font Awesome](https://fontawesome.com)

## Credits
ButterDocs is currently being developed by [Gabriel Silva](https://eugabrielsilva.tk).