28 lines
899 B
Markdown
28 lines
899 B
Markdown
# QWiki *2015-10-11 14:55:35*
|
|
QWiki is a simple wiki design implemented in node.js.
|
|
|
|
## Installation
|
|
* npm install
|
|
* node index.js [--port=7331]
|
|
|
|
## Impetus
|
|
1. straight-forward and small wiki
|
|
2. no database requirements
|
|
3. easy to deploy
|
|
|
|
## Designs
|
|
1. filesystem database
|
|
2. actions based on request paths ("my_page/edit", "my_page/delete", etc.) rather than queries
|
|
3. HTML customization via "style.css" in wiki root and "index.html" template in QWiki root.
|
|
4. extendable wiki page formats such as markdown, html, or others
|
|
|
|
## Components
|
|
* QCore
|
|
- limited HTTP server that handles POST data, mimetypes, page templating, etc.
|
|
- handles templating rules and page actions
|
|
* QParse
|
|
- object that holds data related to generating a page from page templating
|
|
* QWiki
|
|
- inherits from QCore
|
|
- handles page saving, cache generation, formatting, and similar
|