From 7c9304ae939ac0368dcee55537a3a56bc619e961 Mon Sep 17 00:00:00 2001 From: Miraty Date: Thu, 7 Oct 2021 10:56:53 +0200 Subject: [PATCH 1/4] New readme (WIP) --- README.md | 51 +++++++++++++++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f3b9c55..92c63c0 100755 --- a/README.md +++ b/README.md @@ -1,31 +1,46 @@ -# Présentation +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. -Ceci est le code source du générateur de sites statiques qui créé le [site web d'Antopie](https://antopie.org). +# Usage -# Utilisation +Place your pages tree in `/src/*/*.(gmi|md)`. -`compil.php ` +Optionnal files: +`/config.ini` +`/style.less` +`/logo.png` +`/head.inc.html` +`/footer.inc.html` -Avec `destination` : -* Pour déployer en DNS en liant vers `page`, utiliser `dns`. -* Pour déployer en Onion en liant vert `page`, utiliser `onion`. -* Pour déployer en DNS en liant vert `page.html`, utiliser `local`. +`mkht.php ` -Exemple pour le site d'Antopie : `compil.php antopie local Antopie` +`destination` is optionnal and can be: +* `dns` if you want local links without exensions +* `onion` if you want links ending with .onion when available -# Bibliothèques utilisées +# Input -Le dossier `bibli` contient les dépendances incluses dans le générateur de sites : +Pages in `/src`can use Gemini (if using `gmi` extension), Markdown, HTML and PHP. -| Nom | Description | Source | +# Output + +`/*/*.gmi` (if using `.gmi` extension in /src) +`/*/*.md` +`/*/*.html` +`/*/*.gz` + +# 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 | -# Licence +# License -Le générateur de sites web d'Antopie est un logiciel libre ; vous pouvez le diffuser et le modifier suivant les termes de la GNU Affero General Public License telle que publiée par la Free Software Foundation ; soit la version 3 de cette licence, soit (à votre convenance) une version ultérieure. - -Le générateur de sites web d'Antopie est diffusé dans l’espoir qu’il sera utile, mais SANS AUCUNE GARANTIE ; sans même une garantie implicite de COMMERCIALISATION ou d’ADÉQUATION À UN USAGE PARTICULIER. Voyez la GNU Affero General Public License pour plus de détails. - -Vous devriez avoir reçu une copie de la GNU Affero General Public License avec ce code. Sinon, consultez https://www.gnu.org/licenses/ +AGPLv3+ \ No newline at end of file From 7467805d87ea77c3e3f31cc58b67274aba378713 Mon Sep 17 00:00:00 2001 From: Miraty Date: Thu, 7 Oct 2021 10:58:37 +0200 Subject: [PATCH 2/4] Fix lists --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 92c63c0..ed14234 100755 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ mkht.php is a PHP script for building Gemini, Markdown and HTML/CSS sites from s Place your pages tree in `/src/*/*.(gmi|md)`. Optionnal files: -`/config.ini` -`/style.less` -`/logo.png` -`/head.inc.html` -`/footer.inc.html` +* `/config.ini` +*`/style.less` +* `/logo.png` +* `/head.inc.html` +* `/footer.inc.html` `mkht.php ` @@ -23,10 +23,10 @@ Pages in `/src`can use Gemini (if using `gmi` extension), Markdown, HTML and PHP # Output -`/*/*.gmi` (if using `.gmi` extension in /src) -`/*/*.md` -`/*/*.html` -`/*/*.gz` +* `/*/*.gmi` (if using `.gmi` extension in /src) +* `/*/*.md` +* `/*/*.html` +* `/*/*.gz` # External dependencies From a90ca1e942875dfd8f3837089aa850b15c8fb2b3 Mon Sep 17 00:00:00 2001 From: Miraty Date: Thu, 7 Oct 2021 11:12:12 +0200 Subject: [PATCH 3/4] Add format ordering precisions --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed14234..3f3344d 100755 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Place your pages tree in `/src/*/*.(gmi|md)`. Optionnal files: * `/config.ini` -*`/style.less` +* `/style.less` * `/logo.png` * `/head.inc.html` * `/footer.inc.html` @@ -28,6 +28,9 @@ Pages in `/src`can use Gemini (if using `gmi` extension), Markdown, HTML and PHP * `/*/*.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 From b601986a06b7e33b219e37f40a10e9f2ba1926ea Mon Sep 17 00:00:00 2001 From: Miraty Date: Thu, 7 Oct 2021 14:14:38 +0200 Subject: [PATCH 4/4] Add license informations --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3f3344d..87c2a0a 100755 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Pages in `/src`can use Gemini (if using `gmi` extension), Markdown, HTML and PHP * `/*/*.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.) +Gemini > Markdown > HTML, which means that the last of these formats you will use will be the first that will be readable by hypertext browsers. (PHP is executed before.) # External dependencies @@ -39,11 +39,17 @@ Gemini > Markdown > HTML, which means that the last of the previous format you w # 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 | +| Name | Description | Source | +| --------- | ------------------------ | ------------------------------------------ | +| less.php | Less compiler in PHP | https://github.com/wikimedia/less.php | +| parsedown | Markdown compiler in PHP | https://parsedown.org | # License -AGPLv3+ \ No newline at end of file +[AGPLv3+](LICENSE) + +This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License along with this program. If not, see . \ No newline at end of file