f53fae166f
- Spelling corrections - Added "Cloning & contributing" to Contributing - Revised commands for filename changes
Logarion
Logarion is a free and open-source personal note taking, journaling and publication system, a blog-wiki hybrid.
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.
Community & support
- Matrix (chat): #logarion:matrix.org (Via Riot webapp: https://riot.im/app/#/room/#logarion:matrix.org)
- Reddit: https://www.reddit.com/r/logarion/
- Issues: https://gitlab.com/orbifx/logarion/issues
Install
For development instructions see [CONTRIBUTING.md]
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 --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 sassc share/sass/main.sass > share/static/main.css, to generate a stylesheet in share/static/main.css, using share/sass/main.sass.