https://github.com/robinn1/phpmdocs

Simple but powerful Markdown documentation.
https://github.com/robinn1/phpmdocs

Last synced: about 1 month ago
JSON representation

Simple but powerful Markdown documentation.

• Host: GitHub
• URL: https://github.com/robinn1/phpmdocs
• Owner: RobiNN1
• License: mit
• Created: 2022-04-05T18:38:45.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-01-23T22:15:41.000Z (4 months ago)
• Last Synced: 2025-03-29T12:04:30.898Z (2 months ago)
• Language: PHP
• Homepage:
• Size: 283 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# phpMDocs

Simple but powerful Markdown documentation.

![Visitor Badge](https://visitor-badge.laobi.icu/badge?page_id=RobiNN1.phpMDocs)

## Features

- Search within Markdown files

- Customizable Twig templates

- Automatically generated ToC and sidebar content

- Cache for faster loading

- Sitemap and robots.txt generator, run to generate `composer sitemap`

## Installation

Extract the content to the root directory of the website.

Or put it to subfolder, in this case, need to update `site_path` option in config.php file.

If necessary, set the path to the documentation content (`docs_path` option).

Run `composer install` before use.

## Requirements

- PHP >= 8.2

- mod_rewrite or alternative