1.5 KiB
Logarion
Summary
(Note: the following summary is a specification, not everything described is complete)
Logarion is a personal journaling and publication system. The suite provides a command line archive interface, a graphical user interfance (coming soon) and a web server.
Design principles:
- System simplicity & interoperability.
- Output quality.
- Distributed interactivity, like sharing with friends.
Logarions articles are stored as plain text Yamado files (.ymd).
YMD files can be stored internally and controlled by Logarion, or they can be piped from other sources.
There are 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.
Install
Make sure you have OCaml >= 4.03. All requirements are available for automatic installation via OPAM
git clone git@github.com:orbifx/logarion.git
cd logarion
make opam.dependencies
make dirs
make
Optionally install a sass compiler, like sassc, and then run make style will generate a stylesheet in share/static/main.css, using share/sass/main.sass.
This should generate web. Run with:
web
and open a browser to http://localhost:3000. To post a new article visit http://localhost:3000/new.