wkallhof / hazel

Fast, simple, markdown powered wiki knowledge base for Node.js

Archived

Hazel is no longer in active development. If you are interested in taking over development, let me know!

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:

• Egor Kuryanovich

License

GPL-3.0

hazel's Issues

Image upload fail with non-existent `uploads_dir` directory

Using the same setup as in #3.
Node version: 6.1.0
NPM version: 3.8.6

When an non-existent uploads_dir key in config.json

In contrast to the content_dir and data_dir being created automatically uploads_dir is not.
Maybe there should be a consistent default behaviour for all three of them?

Moreover when uploading without a uploads_dir the upload progress bar indicates a successful upload, although nothing is actually saved. When hovering over the upload file the pop-over shows "[Object Object]".
That should be changed, too, IMHO.

Page with same title overwrite existing page

I would expect that trying to name a page to the same as another page would throw up an error. Instead, Hazel silently overwrites the existing file.

Is it possible to disable "Create New Document" option?

I have documentation for readers users , so I need to disable this option.

Is it possible to do this in configuration section?

Thanks a lot.

Any chance to configure a Database to store data in future versions?

Hey guys, Hazel is a very nice projet, simple and useful. It would be nice if we could configure it to store data in a database. Any chance of it happens?

Ugly error message on failed form validation during document creation

$ node --version 
v6.1.0
$ npm --version 
3.8.6

Trying to create a new page without supplying a title leads to a blank page only showing Cannot POST /save.

When creating a document with a title and the other fields left blank one is redirected to a page saying the page could not be created. On the home page the document link to the non-existent page apperas as if it had been created successfully.

header blocking editing elements

as you see header blocking editing elements while in fullscreen or split panel mode

Simplemde fullscreen overlaps default theme

.navbar {
  font-family: Muli;
  font-weight: 400;
  font-style: normal;
  font-size: 14px;
  z-index:5; <---
}

META info syntax question/suggestion

Would it be possible to put the META information in a markdown-invisible expression? For instance

[META]: # ({"title":"Home","tags":["overview"],"createDate":1512133049820,"updateDate":1512133049820})

instead of the HTML comment block Hazel uses now, which is visible in standard md viewers:

<!--META {"title":"Home","tags":["overview"],"createDate":1512133049820,"updateDate":1512133049820} -->

More info: https://stackoverflow.com/questions/4823468/comments-in-markdown

Thank you for this piece of software, it is very useful to me!

Does not work for nested folders with markdown files

I tried to use this tool to my dozens of folders with markdown but only markdown files in root path are scanned.

Also new created documents are stored in root content folder without option to create or locate an folder.

Is this functionality implemented?

Thanks a lot.

Feature Request -- Syntax Highlighting

Perhaps you have already mentioned this in a previous question. Will there be some for of syntax highlighting feature added to this wiki?

I am curious, thanks!

Illegal Characters

When uploading files the editor breaks on file names with ")". This maybe the solution.

this.dropzone.on("addedfile", function(file){
		if(file.name.indexOf("(") > 0 || file.name.indexOf(")") > 0){
			alert('File Contains illegal Characters');
			this.removeFile(file);
		}
	});

folders?

This is a beautiful project and I love the simplicity. But I am wondering if there are ways (or plans) for having more of a hierarchy via folders. And is it possible to have a tag column on the homepage? Thank you for your work

Auto Linking only links first item in a document

Hazel/app/controllers/documentController.js

Lines 106 to 113 in a4b4ebc

	if (missingLinks && missingLinks.length > 0) {
	var pairs = _.chunk(missingLinks, 2);
	_.forEach(pairs, (pair) => {
	let slug = this._storageProvider.titleToSlug(pair[1]);
	document.markdown = document.markdown.replace(pair[0], pair[0].replace("()", "(/" + slug + ")"));
	});
	}

I updated this code to (but also moved to using slugify):

      missingLinks.forEach((link) => {
        const title = link.substr(1).slice(0, -3);
        const pairSlug = slugify(title, { lower: true });
        document.markdown = document.markdown.replace(link, `[${title}](/${pairSlug})`);
      });

Also needed to make this RegEx a global search:

Hazel/app/utilities/documentParserUtility.js

Line 13 in a4b4ebc

this._missingLinkRegex = /\[(.*)\]\(\)/;

this._missingLinkRegex = /\[(.*)\]\(\)/g;

Single Line Break not working

Double Like breaks work but the single line break doesn't drop the information to the next line.

it seems something like this is needed on the documentController.js

marked.setOptions({
		  breaks: true,
		});

Expose AuthenticationProvider?

Hello, this project has taken my interest and I would like to make use of it, however it doesn't seem to expose the authenticationProvider, which I want to modify to suit my own needs. Is this in the pipeline? Thanks

Upload doesnt work in IE on Default Theme

This is needed on line 42 of edit.js

if ( file.type.indexOf( "image/" ) == 0 ) {

Bitwise & instead of logical &&

There is a missing & on this line https://github.com/wkallhof/Hazel/blob/master/app/controllers/documentController.js#L121

Didn't find this until I was too deep into hacking away and changed basically every single file otherwise I would open a PR.

Thanks for making/releasing/sharing this!

Comparison with jingo

http://stackoverflow.com/questions/5956167/has-anyone-implemented-a-wiki-in-nodejs

Would be nice if the README mentioned prior art.

Running behind Apache proxy, `base` directive doesn't seem to have any effect

Hello there, first of all – thanks for your effort, Hazel looks great as far as I can judge from what I've seen so far.

However, trying to set up my personal instance on a shared hosting I encountered the following error.
I'm attempting to run Hazel behind an Apache and in a sub-directory:

http://domain.com/wiki

Therefore I set base in my config.default.js:

var config = {
  //  Your site title (format: page_title - site_title)
  site_title: "Abacus Wiki",

  //Application base url
  base: "/wiki/",
};
// Exports
module.exports = config;

My .htaccess in the specified dir /wiki contains a rewrite

RewriteEngine On
RewriteRule (.*) http://localhost:62626/$1 [P]

directing any request to the running Hazel server.

Still the paths in the resulting HTML pages are incorrect (e.g. /styles/tidy.css) resulting in un-styled pages.

What is wrong here?

Page Access Control?

Hi I was wondering if there was a way to set roles for admins and users? Like if a user has wikis locked out to them until after 3 months after which I can enable access to them (as an admin)?