💾 Archived View for smol.earth › compendium › file-format.gmi captured on 2023-11-14 at 07:47:27. Gemini links have been rewritten to link to archived content

View Raw

More Information

⬅️ Previous capture (2023-09-28)

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

Compendium curator's file format

The curator's file format is extremely simple. Each line is a whitespace (space or tab, you choose) separated list of tokens. The first token on a line must be a gemini:// or gopher:// URL. All subsequent tokens on that line are interpreted as tags to be attached to that URL. A line must include at least one tag, but can include as many as you like.

Because tags are whitespace separated, this means no spaces inside tags. By convention, use one word tags preferentially and when multiple words are necessary, use hyphens as a separator, e.g. `climate-change`.

Tags are case insensitive, and will be lower-cased by the compendium software.

Lines in a file which do not comply with the above rules will simply be ignored, so you can leave blank lines or comments to yourself if you like.

Your curator's file will be fetched once per day. Once a URL and its tags are in the database, they'll stay there even if they aren't in your curator's file upon the next fetch. This means your file doesn't need to grow forever into a huge file including everything you ever submitted. When you feel like it's getting too long, just delete some old stuff from the top (or bottom, depending on your workflow) that you know has been in there for more than 24 hours.