Go to file

kts of kettek 23aead1e95 Added breadcrumbs functionality and modified css colors a bit		2015-10-11 23:41:15 -07:00
wiki	Added breadcrumbs functionality and modified css colors a bit	2015-10-11 23:41:15 -07:00
.gitignore	Initial commit of QWiki. Currently uses markdown as default (and cannot be changed outside of system code). Lacking some functionality. Needs to split into multiple component/module files, such as QCore and QWiki.	2015-10-11 15:09:43 -07:00
README.md	Initial commit of QWiki. Currently uses markdown as default (and cannot be changed outside of system code). Lacking some functionality. Needs to split into multiple component/module files, such as QCore and QWiki.	2015-10-11 15:09:43 -07:00
index.html	Added breadcrumbs functionality and modified css colors a bit	2015-10-11 23:41:15 -07:00
index.js	Added breadcrumbs functionality and modified css colors a bit	2015-10-11 23:41:15 -07:00
package.json	Initial commit of QWiki. Currently uses markdown as default (and cannot be changed outside of system code). Lacking some functionality. Needs to split into multiple component/module files, such as QCore and QWiki.	2015-10-11 15:09:43 -07:00

README.md

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

straight-forward and small wiki
no database requirements
easy to deploy

Designs

filesystem database
actions based on request paths ("my_page/edit", "my_page/delete", etc.) rather than queries
HTML customization via "style.css" in wiki root and "index.html" template in QWiki root.
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