1
0
mirror of https://tildegit.org/sbgodin/HtmGem.git synced 2023-08-25 13:53:12 +02:00
HtmGem/docs/installation-en.gmi

51 lines
1.3 KiB
Plaintext
Raw Permalink Normal View History

2022-08-01 11:15:30 +02:00
# To install HtmGem
2021-03-27 23:31:47 +01:00
2022-08-01 11:15:30 +02:00
* Download HtmGem
=> https://tildegit.org/sbgodin/HtmGem/archive/master.zip
* Copy the files at the root of the website.
* Configurer la réécriture dURL (//URL Rewriting//).
* Write some text in /index.gmi.
* Just open your website!
2021-03-27 23:31:47 +01:00
2022-08-01 11:15:30 +02:00
* Go to /htmgem to get the documentation.
2021-03-27 23:31:47 +01:00
2022-08-01 11:15:30 +02:00
### Prerequisites
2021-03-27 23:31:47 +01:00
2022-08-01 11:15:30 +02:00
* Php v7.3 minimum
* Module **Php-mbstring** to handle lunicode
* A web server (Apache and Nginx supported)
* Module **mod-rewrite** for the URL rewriting
2021-03-27 23:31:47 +01:00
### Nginx
```
2021-03-28 21:50:36 +02:00
index index.gmi index.php index.html
2022-08-01 11:15:30 +02:00
rewrite ^(.+\.gmi)$ /htmgem/index.php?rw=1&url=$1&style=default,htmgem.css;
error_page 403 /htmgem;
location = /favicon.ico { alias /var/www/dev/htmgem/favicon.ico; }
2021-03-27 23:31:47 +01:00
```
### Apache
```
2021-03-28 21:50:36 +02:00
DirectoryIndex index.gmi index.php index.html
2021-03-27 23:31:47 +01:00
RewriteEngine on
RewriteRule ^(.+\.gmi)$ htmgem/index.php?rw=1&url=$1&style=default,htmgem.css
2021-03-27 23:31:47 +01:00
```
Other available styles:
* style=lagrange,lagrange.css
* style=lagrange,lagrange_gray.css
* style=default,circumlunar.css
* etc…
2022-08-01 11:15:30 +02:00
## Text decoration
The text decoration, which interprets the bold for instance, is not part of GemText definition. The text decoration applies everywhere except on the titles and preformated texts.
It's possible to disable the text decoration with a line **^^^** or add to the URL rewriting:
> &textDecoration=0
2021-03-27 23:31:47 +01:00
2022-08-01 11:15:30 +02:00
=> ../css Styles
2021-03-27 23:31:47 +01:00
2022-08-01 11:15:30 +02:00
=> tutogemtext-en.gmi How to make GemText pages?