Logarion text system

Start your own Logarion archive

| | | topics: Basics | keywords: download, guide, packages
id: c0615a9d-3844-4b56-91cc-4b1968ddd7ab

Download

Download the appropriate pre-build package for your machine at:

https://logarion.orbitalfox.eu/downloads

or build it. Logarion is written in OCaml, an industrial strength functional programming language.

Starting your repository

A repository has the following elements:

To get started:

logarion init

(Note: you need ./ if the executables are not installed in your system's $PATH .)

This will create a .logarion/ directory with the config.toml and static/ for files. Edit the config.toml file to suit your needs. The fields are self-explanatory, with the most important ones being title, owner, email.

Once ready, create your first text:

logarion create "Hello world"

This will automatically produce a hello-world.0.md file, containing a pre-populated meta section and a couple of lines for you to enter your text.

Use your favourite editor to modify the generated file. Some editors to wet your appetite:

There are a lot of editors to choose from. Logarion isn't affected by which editor is used. Read more about header fields.

Source of Logarion's own archive here: https://cgit.orbitalfox.eu/logarion-texts/tree/.

Export to HTML

To generate a website for your archive, copy some essential theme files (css and fonts) in .logarion/static. There is a basic stylesheet to begin with. Then generate the website:

 logarion convert "html"

Where "html" is the directory you wish the website files to created in. This will:

Upload the files inside the html folder on to your web server for publication. For example, with rsync:

rsync -r html/* user@server:/path/to/web-dir

Sharing a feed

When exporting in HTML, Logarion generates a feed.atom file. This file can be subscribed to by those interested in your archive's content and changes, using an Atom - news aggregator.

For example with Firefox's live bookmarks one can follow an archive's changes with a click of an icon.