💾 Archived View for dj-chase.com › meta › readme.gmi captured on 2024-05-26 at 14:51:20. Gemini links have been rewritten to link to archived content

View Raw

More Information

⬅️ Previous capture (2022-06-11)

-=-=-=-=-=-=-

dj-chase.com README

Hi! This is the source for my site. It’s aranged like this:

• all files are written in slighty-modified txt2tags format, then compiled with ./Make.py. See § Format for more information about the format.
• options to Make.py control whether files get footers and whether they’re (re)indexed in the list of articles and feed.
• built files are in the same dir as source files because the site is literally just a non-bare git repo; any files in the current master are accessible via git, gemini, and https.
• i push frequently with little-to-no regard for log-quality. this forces me to work on the site because otherwise I have poor-quality files accessible.

See COUNTRIBUTING for how to submit patches.

Format

txt2tags is a simple format that’s a good compromise between gemtext’s simplicity and html’s semantics. I chose not to ues markdown because I don’t particularily like markdown. There’s documentation on the project web-site:

txt2tags documentation

also note that Make.py adds two commands: %!html: and %!gmi:. When at the begining of a line, these commands make that line only show up in the respective output format. They are processed before the file’s handed off to txt2tags, so the rest of the line (after an optional whitespace character) is treated exactly like any other input-line. Take this snippet as an example:

 Here are some links:

 %!html: - [foo https://example.com/]
 %!html: - [bar https://example.net/]
 %!html: - [baz https://example.org/]
 %!html: - [qux https://example.edu/]
 %!html:
 %!gmi: [foo https://example.com/]
 %!gmi: [bar https://example.net/]
 %!gmi: [baz https://example.org/]
 %!gmi: [qux https://example.edu/]

 Lorim ipsum dolar sit amet.

Before converting to html, this will become the following:

 Here are some links:

 - [foo https://example.com/]
 - [bar https://example.net/]
 - [baz https://example.org/]
 - [qux https://example.edu/]


 Lorim ipsum dolar sit amet.

But before converting the gemtext, it will become this:

 Here are some links:

 [foo https://example.com/]
 [bar https://example.net/]
 [baz https://example.org/]
 [qux https://example.edu/]

 Lorim ipsum dolar sit amet.

This is useful for format differences — such as gemtext not supporting explicit lists of links — and etc.

Style guide

TODO