kalyashka/srcdoc

Translates your source files to HTML, which you can later convert to .docx, .pdf

0.1.0 2019-01-09 08:38 UTC

Requires

• php: >=7.1
• scrivo/highlight.php: ^9.13
• symfony/console: ^4.2

Requires (Dev)

• phpunit/phpunit: ^7.5

MIT

• Nikolay Grom

README

A command line utility for collecting and pasting source code in html document. Uses scrivo/highlight.php for syntax highlighting.

Installation

composer global require kalyashka/srcdoc

Usage

srcdoc [options] [<directory>]

where <directory> - root directory with source files (defaults to current directory) options:

• --help, -h - show help
• --extensions, -e - file extensions (comma separated, "php,js,css,scss")
• --exclude, -x - files/directories patterns for exclude (e.g. "vendor,assets", comma separated)
• --output, -o - output file name (stdout will be used if not provided)
• --list, -l - do not scan directory and use listing file (one file per line)
• --no-syntax, -s - disable syntax highlighting
• --theme, t - use one of highlight.php theme
• --theme-list - outputs list of highlight.php themes
• --heading - heading tag (default h3)

Example

srcdoc -e vendor -x "php,js,css" --heading h2 --theme idea -o doc.html