kts
/
QWiki
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
10 Commits
1 Branch
0 Tags
572 KiB
JavaScript 77.1%
CSS 20.8%
HTML 2.1%
 
 
 
Go to file
kts of kettek 312197cd41 Changed QWiki to now load acts from the acts directory. At the moment, there is no 'hotswapping' of acts, but this should be much more manageable. 2016-01-21 16:22:57 -08:00
acts Changed QWiki to now load acts from the acts directory. At the moment, there is no 'hotswapping' of acts, but this should be much more manageable. 2016-01-21 16:22:57 -08:00
wiki Changed body weight to 300 and headers to 700. Now uses Roboto Mono instead of Ubuntu Mono since Roboto Slab was being used for the body. Added CSS styling to code tags. Fixed bug with markdown source being fed a Buffer when it needed a String (why did this work before..?). Added a TODO.md file. 2016-01-21 11:44:26 -08: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
TODO.md Changed body weight to 300 and headers to 700. Now uses Roboto Mono instead of Ubuntu Mono since Roboto Slab was being used for the body. Added CSS styling to code tags. Fixed bug with markdown source being fed a Buffer when it needed a String (why did this work before..?). Added a TODO.md file. 2016-01-21 11:44:26 -08:00
index.html Changed body weight to 300 and headers to 700. Now uses Roboto Mono instead of Ubuntu Mono since Roboto Slab was being used for the body. Added CSS styling to code tags. Fixed bug with markdown source being fed a Buffer when it needed a String (why did this work before..?). Added a TODO.md file. 2016-01-21 11:44:26 -08:00
index.js Changed QWiki to now load acts from the acts directory. At the moment, there is no 'hotswapping' of acts, but this should be much more manageable. 2016-01-21 16:22:57 -08:00
package.json Default markdown formatter is now markdown-it. This gives access to extended functionality such as: table of contents generation, super text, section tags, definition lists, and much more. 2015-12-17 17:06:21 -08: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

  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