|
||
---|---|---|
acts | ||
resources | ||
wiki | ||
.gitignore | ||
QCore.js | ||
README.md | ||
TODO.md | ||
index.html | ||
index.js | ||
package.json |
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