Go to file
kts of kettek 331eca575d Adjusted body background to be separate from the content background -- also added a shadow to the content. Updated TODO for future snazz. 2016-01-24 05:15:34 -08:00
acts URL requests for files now defaults to application/octet-stream if it is not defined as a mimetype. delete act now can delete files as well as wiki entries -- it should be capable of deleting directories as well. formidable is now a requirement and adds the fields and files properties to the req object. Uploading files now works with the upload act. Fixed minor bugs with readDirectory and otherwise. 2016-01-23 21:14:48 -08:00
wiki Adjusted body background to be separate from the content background -- also added a shadow to the content. Updated TODO for future snazz. 2016-01-24 05:15:34 -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 Adjusted body background to be separate from the content background -- also added a shadow to the content. Updated TODO for future snazz. 2016-01-24 05:15:34 -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 URL requests for files now defaults to application/octet-stream if it is not defined as a mimetype. delete act now can delete files as well as wiki entries -- it should be capable of deleting directories as well. formidable is now a requirement and adds the fields and files properties to the req object. Uploading files now works with the upload act. Fixed minor bugs with readDirectory and otherwise. 2016-01-23 21:14:48 -08:00
package.json URL requests for files now defaults to application/octet-stream if it is not defined as a mimetype. delete act now can delete files as well as wiki entries -- it should be capable of deleting directories as well. formidable is now a requirement and adds the fields and files properties to the req object. Uploading files now works with the upload act. Fixed minor bugs with readDirectory and otherwise. 2016-01-23 21:14:48 -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