Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

theodorosploumis/php-docs

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

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

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

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

About

A simple web tool to create html docs under git from structured markdown files.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors 2

  •  
  •  
Morty Proxy This is a proxified and sanitized view of the page, visit original site.