2021-10-07 10:56:53 +02:00
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.
2018-10-29 19:37:15 +01:00
2021-10-07 10:56:53 +02:00
# Usage
2020-08-23 00:02:38 +02:00
2021-10-07 10:56:53 +02:00
Place your pages tree in `/src/*/*.(gmi|md)` .
2020-08-23 00:02:38 +02:00
2021-10-07 10:56:53 +02:00
Optionnal files:
2021-10-07 10:58:37 +02:00
* `/config.ini`
2021-10-07 11:12:12 +02:00
* `/style.less`
2021-10-07 10:58:37 +02:00
* `/logo.png`
* `/head.inc.html`
* `/footer.inc.html`
2020-08-23 00:02:38 +02:00
2021-10-07 10:56:53 +02:00
`mkht.php <site path> <destination >`
2021-04-05 18:32:22 +02:00
2021-10-07 10:56:53 +02:00
`destination` is optionnal and can be:
* `dns` if you want local links without exensions
* `onion` if you want links ending with .onion when available
2021-09-15 23:15:48 +02:00
2021-10-07 10:56:53 +02:00
# Input
2019-03-22 21:39:49 +01:00
2021-10-07 10:56:53 +02:00
Pages in `/src` can use Gemini (if using `gmi` extension), Markdown, HTML and PHP.
2021-04-05 18:32:22 +02:00
2021-10-07 10:56:53 +02:00
# Output
2021-10-07 10:58:37 +02:00
* `/*/*.gmi` (if using `.gmi` extension in /src)
* `/*/*.md`
* `/*/*.html`
* `/*/*.gz`
2021-10-07 10:56:53 +02:00
2021-10-07 11:12:12 +02:00
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.)
2021-10-07 10:56:53 +02:00
# External dependencies
* PHP
* gzip
* find
# Internal libraries used
| Name | Description | Source |
2021-04-05 18:32:22 +02:00
| --------- | --------------------------- | ------------------------------------------ |
2021-09-18 19:08:26 +02:00
| less.php | Compilateur Less en PHP | https://github.com/wikimedia/less.php |
2021-04-05 18:32:22 +02:00
| parsedown | Compilateur Markdown en PHP | https://parsedown.org |
2021-10-07 10:56:53 +02:00
# License
2019-03-22 21:39:49 +01:00
2021-10-07 10:56:53 +02:00
AGPLv3+