Librarium is a simple content management system. It is written in JavaScript and is intended to be executed on Node.js. Blogs and diaries are main targets of the software. The goal is to help building pure and flexible document archives.
The most characteristic point of Librarium is that it is document-oriented. The system of the contents managed by Librarium could be divided into two parts; Documents and Indices. Documents are contents themselves, such as texts, while Indices sort the Documents and provide quick paths to them in multiple ways, including web feeds. Librarium just does read documents, recognize their title and body, reconstruct into a new HTML document to be published using a template, then rebuild a document index. Thus everything could be served to the public by HTTP servers as static files. As well, there is a strict rule that every source content managed by Librarium must be an independent HTML document. This rule derives from the philosophy of Librarium that HTML is more proper format to preserve electronical documents.
Librarium is also unique as it records indices in the form of JSON. Lightweight Resource Index Object is proposed within Librarium, in accordance of a belief that URI should be a sole pointer of the resource available. Librarium aims to demonstrate how powerful and how computer-friendly the object notation of resource index could be, comparing to XML-based syndication systems. Hence Librarium keeps the document index in public as index.json and provides an aggregation of basic resource information in JSON, alongside web feeds in other formats, like RSS.
Simplicity is not forgotten, of course. Just create a directory for the document, tell the name to the programme, and find out you have already done!
- Prepare an HTTP server to serve contents.
- Edit
cms/config.json $ node cms/run.js add sample- Modify
sample/source.htmla lot then$ node cms/run.js update sample - Modify
sample/source.htmla little then$ node cms/run.js reform sample - Modify
templates/docthen$ node cms/run.js renovate $ node cms/run.js remove sample
- Author valid HTML5 documents for
source.html. Feeding other types of documents or invalid documents is neither supported nor tested.
Copyright (C) 2014 Makoto Mizukami. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
© Makoto Mizukami MMXIV