nvdnkpr / melkor

Wiki powered by Node.js and Git

melkor

<- waiting for node-sass bugfix, melkor works fine with node 0.11.10

A simple, fast wiki powered by Node.js and Git.

Features

• Git back-end storage
• Markdown editing, Github flavour
• Responsive layout (adapts to screen size)
• AJAX-powered editing and navigation (with graceful degradation)

Usage

Melkor uses generators - Node v0.11.2+ is required. And ensure you have the Git global user configured.

$ npm install -g melkor
$ mkdir mywikifolder
$ cd mywikifolder
$ melkor

Browse to http://localhost:4567 to start using the wiki.

Command-line options:

Usage: melkor [options]

Options:

  -h, --help           output usage information
  -p, --port <num>     Port number (Default: 4567)
  -t, --title <title>  Wiki title (Default: Wiki)
  -a, --ajax           Enable AJAX navigation and editing

Development

$ npm install -g grunt-cli
$ npm install -g bower
$ npm install
$ bower install
$ npm run build <-- this will build the code and run the tests

Why Melkor?

Melkor was inspired by Gollum, named after another Lord of the Rings character. Melkor itself is the original name of Morgoth, the most powerful dark lord and biggest badass!

License

MIT - see LICENSE.md