2017-11-02 23:53:19 +00:00
2016-09-26 16:49:02 +01:00
2017-11-02 23:53:19 +00:00
2017-08-07 22:12:49 +01:00
2017-10-01 20:57:29 +01:00
2017-11-02 23:17:52 +00:00
2017-09-17 19:02:48 +01:00

Logarion

Logarion is a free and open-source personal note taking, journaling and publication system, a blog-wiki hybrid.

Screenshots of stock themes.

Features

Plain file system store (each note is a file). Command line & web interfaces.

Two publishing modes:

  • Static, published upon a command. Suitable for scenarios where installation on the server is not possible.

  • Dynamic, using web server. Supports interactive features like searching and more advanced Atom feed parameters.

For more features, options and guides visit the Wiki.

Community & support

Install

For development instructions see CONTRIBUTING.md.

The following instructions are the quickest way to install Logarion (in the absense of binary releases).

opam pin add logarion https://gitlab.com/orbifx/logarion.git
opam install logarion

Configure

Before running Logarion, configure logarion.toml, which is the core configuration file. The webserver has an additional configuration file, explained at Web server section below.

Running

Once installed you will have logarion_cli for command line control of the repository and logarion_webserver for web access.

Command line

Run logarion_cli --help.

Web server

The web server's configuration is optionally controlled by web.toml in the directory the server is executed from.

Run logarion_webserver and open a browser to http://localhost:3666. To post a new article visit http://localhost:3666/new.note.

Optionally install a Sass compiler, like sassc, and then run make theme-dark or make theme-light, to generate a stylesheet as share/static/main.css, using the respective Sass files in share/sass/.

See also

Description
Archive of Logarion's source code from the year 2016 to 2017, before the history rewrite
Readme 451 KiB
Languages
OCaml 89.1%
Sass 5%
CSS 4.9%
Makefile 0.6%
Mustache 0.4%