This repository has been archived on 2023-05-26. You can view files and clone it, but cannot push or open issues or pull requests.
web/README.md

1.3 KiB
Executable File

mkht.php is a PHP script for building Gemini, Markdown and HTML/CSS sites from source documents in Gemini, Markdown, HTML, PHP, CSS and Less.

Usage

Place your pages tree in /src/*/*.(gmi|md).

Optionnal files:

  • /config.ini
  • /style.less
  • /logo.png
  • /head.inc.html
  • /footer.inc.html

mkht.php <site path> <destination >

destination is optionnal and can be:

  • dns if you want local links without exensions
  • onion if you want links ending with .onion when available

Input

Pages in /srccan use Gemini (if using gmi extension), Markdown, HTML and PHP.

Output

  • /*/*.gmi (if using .gmi extension in /src)
  • /*/*.md
  • /*/*.html
  • /*/*.gz

Note that format translation is only done in the following order: Gemini > Markdown > HTML, which means that the last of the previous format you will use will be the first that will be readable by hypertext browsers. (PHP is executed before.)

External dependencies

  • PHP
  • gzip
  • find

Internal libraries used

Name Description Source
less.php Compilateur Less en PHP https://github.com/wikimedia/less.php
parsedown Compilateur Markdown en PHP https://parsedown.org

License

AGPLv3+