gemlog.sh/README.md

24 lines
1003 B
Markdown
Raw Normal View History

2020-09-02 22:52:31 +00:00
# gemlog.sh
2020-09-10 05:10:19 +00:00
Utility for writing and managing gemini logs (gemlogs) and atom feeds without
needing a cgi script.
2020-09-02 22:52:31 +00:00
2020-09-10 05:10:19 +00:00
To install:
1. put it wherever you want and just add it to path
2. make sure you modify `make_globals()` and `build_entries()` in the script to
customize it to your gemlog.
2020-09-02 22:52:31 +00:00
To use:
2020-09-10 05:11:05 +00:00
1. Write your post in .gmi format. The first header of any level on the page
2020-09-10 05:10:19 +00:00
will be used as a title (it doesn't have to be on the first line). The
script will detect any .gmi files that start with a number and assume
they're blog posts. It'll display them in reverse alphabetical order, so I
recommend to name your files like `YYYY-MM-DD.gmi` or
`YYYY-MM-DD-title-here.gmi` so you get them sorted nicely in reverse
chronological order.
2020-09-10 05:11:05 +00:00
2. make sure you're in your gemlog directory then run `gemlog.sh` to build the
2020-09-10 05:10:19 +00:00
index page and the atom feed
2020-09-10 05:11:05 +00:00
3. if you want your atom feed to be accessible over the web as well as gemini,
2020-09-10 05:10:19 +00:00
symlink the atom.xml file to your web server directory
2020-09-02 22:52:31 +00:00