Logarion

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:

Create the .logarion/ directory and install basic files with:

./logarion init

(Note: you only 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.

Export to HTML

To generate a website for your archive, copy some essential theme files (css and fonts):

cp -r share/static/* .logarion/static/

then generate the website:

./logarion_cli convert "html"

Where html/ is the directory you wish the website files to created in. This will convert all of your published files, generate index.html, log.html, feed.atom, and copy all files from .logarion/static into html/static. Upload the contents of inside the html folder on do your web server for publication.

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.