compudanzas/README.md

91 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2021-06-17 01:21:13 +00:00
# compudanzas
2022-03-28 01:42:34 +00:00
this repository contains the script and source files for the compudanzas site in gemini and the web
2021-06-17 01:21:13 +00:00
2021-06-18 03:32:35 +00:00
* generated in web/ : [https://compudanzas.net](https://compudanzas.net)
* generated in gem/ : [gemini://compudanzas.net](gemini://compudanzas.net/)
2021-06-17 01:21:13 +00:00
# generate site
2022-03-28 01:42:34 +00:00
the generator script requires lua.
2021-06-17 01:21:13 +00:00
2022-03-28 01:42:34 +00:00
it was developed using lua 5.3.3 but it probably works with previous versions.
in order to call the script and build the site:
```sh
$ lua generasitio.lua
2021-06-17 01:21:13 +00:00
```
2022-03-28 01:42:34 +00:00
## archive
2021-06-17 01:21:13 +00:00
2022-03-28 01:42:34 +00:00
the `etc/generador/` directory contains the previous generator files and `README.md`, written in bash, awk and python.
2021-06-17 01:21:13 +00:00
# .gmo format
the same format as gmi (gemtext), but with the following line types:
2021-11-25 23:33:45 +00:00
* `+` add this line to the html file but not to the gmi file
* `&` add this line to the gmi file but not to the html file
2021-07-26 17:46:48 +00:00
# wikilinks
## inline wikilinks
2022-01-22 00:45:52 +00:00
the generator can parse and convert inline {wikilinks}, as many as needed per line
2021-07-26 17:46:48 +00:00
2022-01-22 00:45:52 +00:00
* in html, they get converted to an inline link
* in gemtext, the links are added after the line with the text
2021-07-26 17:46:48 +00:00
.gmo text:
```
see the {roadmap} for updates that want to happen.
```
converted to html:
```html
<p>
2021-08-25 17:57:42 +00:00
see the <a href='./roadmap.html'>roadmap</a> for updates that want to happen.
2021-07-26 17:46:48 +00:00
</p>
```
converted to gemtext:
```gemtext
2022-01-06 20:09:38 +00:00
see the roadmap for updates that want to happen.
=> ./roadmap.gmi roadmap
2021-07-26 17:46:48 +00:00
```
spaces inside the wikilinks are converted to underscores.
## gemtext-like wikilinks
the generator can also parse normal links in gemtext, one per line
* in html, it gets converted to an inline link
* in gemtext, the link is left as is
.gmo text:
```
=> ./references.gmi {references}
```
converted to html:
```html
2021-08-25 17:57:42 +00:00
<p><a href='./references.html'>references</a></p>
2021-07-26 17:46:48 +00:00
```
converted to gemtext:
```
2022-01-06 20:09:38 +00:00
=> ./references.gmi references
2021-07-26 17:46:48 +00:00
```
2021-11-09 19:00:31 +00:00
# license
2024-04-18 20:28:34 +00:00
[CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)