genlog/README.md

41 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2022-03-10 23:32:57 +01:00
# genlog
2022-03-12 01:22:52 +01:00
install [scdoc](https://git.sr.ht/~sircmpwn/scdoc) and [gmnitohtml](https://git.sr.ht/~adnano/gmnitohtml)
clone this repo
2022-03-12 02:19:01 +01:00
``` chmod +x genlog.sh ```
2022-03-12 01:23:25 +01:00
your .gmi files are converted in html and concatenated with the html/header.html and the html/footer.html
2022-03-12 02:00:07 +01:00
the .html file is witen in the directory of the .gmi file which has been treated
2022-05-06 21:59:45 +02:00
this script will recursively search all .gmi files contained in the "content" folder or a path given as an argument to the script, even in the other folders it includes
2022-03-12 02:00:07 +01:00
feel free to customize the html/header.html and the html/footer.html as you like
please keep the
```HTML
<title>
<!-- TITLE -->
</title>
```
in the html/header.html file if you want your generated pages to have a properly defined title in the HTML
2022-05-06 21:59:45 +02:00
## usage
put your files to be processed in the "content" folder then lauch the script
2022-05-06 21:59:45 +02:00
``` ./genlog.sh ```
or
you can also put the path to your folder with the files to be processed as the first argument
2022-05-06 21:59:45 +02:00
``` ./genlog.sh /path/to/your/choosen/folder ```
2022-05-06 23:52:16 +02:00
or
you can optionally add a text at the end of the HTML page title as the second argument
2022-05-06 23:52:16 +02:00
```./genlog.sh /path/to/your/choosen/folder "Your custom title"```
2023-08-18 02:39:50 +02:00
this project uses the [HotChocolateLicence](https://codeberg.org/OniriCorpe/HotChocolateLicence)