1.7 KiB
Logarion
Summary
Logarion is a free and open-source personal note taking, journaling and publication system, a hybrid between a "Blog" and a "Wiki". There is a command line archive interface, a graphical user interface (coming soon) and a web server.
Notes are stored as plain text files.
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
opam pin add logarion https://github.com/orbifx/logarion.git
opam install logarion
Running
Once installed you will have logarion for command line control of the repository and logarion-web for web access.
Command line
Run logarion --help.
The archive's configuration is optionally controlled by logarion.toml in the directory the server is executed from.
Web server
Run logarion-web, and open a browser to http://localhost:3666.
To post a new article visit http://localhost:3666/new.note.
The web server's configuration is optionally controlled by web.toml in the directory the server is executed from.
Optionally install a sass compiler, like sassc, and then run sassc share/sass/main.sass > share/static/main.css, to generate a stylesheet in share/static/main.css, using share/sass/main.sass.