Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theodorosploumis/php-docs
A simple web tool to create html docs under git from structured markdown files.
https://github.com/theodorosploumis/php-docs
docs documentation drupal drupal8 generator hacktoberfest jamstack markdown php
Last synced: 3 months ago
JSON representation
A simple web tool to create html docs under git from structured markdown files.
- Host: GitHub
- URL: https://github.com/theodorosploumis/php-docs
- Owner: theodorosploumis
- Created: 2020-07-03T14:59:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-06T11:52:15.000Z (6 months ago)
- Last Synced: 2024-09-28T10:25:14.876Z (3 months ago)
- Topics: docs, documentation, drupal, drupal8, generator, hacktoberfest, jamstack, markdown, php
- Language: PHP
- Homepage: https://theodorosploumis.github.io/php-docs/example.html
- Size: 15.3 MB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PHP Documentation Generator
## About
A simple web tool to create html docs under git from structured markdown files.
I use it to create Drupal manuals based on structure of
[theodorosploumis/drupal-manual](https://github.com/theodorosploumis/drupal-manual).
## Features
- One page docs
- HTML default output
- Single pages option
- Version control data
- Structured data
- Simple to install and start with
- Custom css with css variables
## Requirements
- composer
- php 7.1+
## Libraries used
- [spatie/yaml-front-matter](https://github.com/spatie/yaml-front-matter)
- [league/commonmark](https://github.com/spatie/league/commonmark)
- [tijsverkoyen/css-to-inline-styles](https://github.com/tijsverkoyen/css-to-inline-styles)
- [dompdf/dompdf](https://github.com/dompdf/dompdf)
## Structure
Normally you should only add/edit files inside these folders.
```
// styling & helper images
css
// md files and images that generate pages
data
```
## Run
```
cp settings.php.example settings.php
composer install
php -S localhost:4777
```
## See also
- [Drupal.org - User Guide project (asciidoc files)](https://www.drupal.org/project/user_guide)
- [Drupal.org - User Guide PDF](https://www.drupal.org/docs/understanding-drupal/user-guide-e-book-downloads)
## ToDo
### php
- document functions
- use global settings inside md (eg site url)
- create a function to generate Taxonomy pages or lists
- livereload on every change
- add html mask numbers (annotations) over images (?)
### Fix dompdf
- add page numbers
- add page numbers to TOC
### data
- allow json data
- add inline md editor
- support Chrome workspaces (for editing)
### export
- support docx
- support pdf (with css styles)
- support json