1.1.8 • Published 6 years ago

hazel-wiki v1.1.8

Weekly downloads
1
License
GPL-3.0
Repository
github
Last release
6 years ago

Hazel: Fast, simple, markdown powered wiki knowledge base for NodeJs

NPM Version NPM Downloads Linux Build Windows Build Test Coverage

Installation

$ npm install hazel-wiki

Setup

const Hazel = require("hazel-wiki").app;
const config = require("./config.default.js");
const StorageProvider = require("hazel-wiki").storageProvider;

let app = new Hazel(config, StorageProvider);
let server = app.server;

server.listen(3000)

For a more in-depth tutorial, check out Getting Started with Hazel

Demo

Use the full featured online demo : http://hazel-demo.wmk.io

Features

  • Simple markdown editing of documents
  • Configurable storage provider architecture (disk, browser, etc.)
  • Leverages Express for routing and exposes the server for configuration
  • Auto-links to existing documents based on link text
  • Customizable templates utilizing EJS

Examples

To view the examples, clone the Hazel repo and install the dependencies:

$ git clone git://github.com/wkallhof/hazel.git --depth 1
$ cd hazel
$ npm install

Then run the example provided:

$ node example/server.js

Tests

To run the test suite, first install the dependencies, then run npm test:

$ npm install
$ npm test

People

The author of Hazel is Wade Kallhoff

Contributions by:

License

GPL-3.0

1.1.8

6 years ago

1.1.7

7 years ago

1.1.6

7 years ago

1.1.5

8 years ago

1.1.4

8 years ago

1.1.3

8 years ago

1.1.2

8 years ago

1.1.1

8 years ago

1.1.0

8 years ago

1.0.7

8 years ago

1.0.6

8 years ago

1.0.5

8 years ago

1.0.4

8 years ago

1.0.3

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago