Skip to content

martinstraus/wikimark

Repository files navigation

Build Status

WikiMark

WikiMark is a super simple, minimalistic, no-nonsense wiki.

All pages are authored using CommonMark. Search is implemented with Apache Lucece. Minimalistic style is provided by Skeleton.

FAQ

Another wiki?

Yes, another wiki.

But why?

But why?

I needed an extremely simple way to author internal documentation for my company (procedures, troblueshootings, projects' info, and the like). I didn't want to use a database. I wanted to be able to back it up super-easily, just tarring some files. I wanted to serve it in our intranet using minimal resources. I didn't want to lock myself to any propietary format, and be able to read those documents in pure text form, in a Linux terminal if needed; CommonMark is the perfect format for that.

MediaWiki is overkill for what I need. I once tried Liferay... never again.

Thus, WikiMark was born.

Building from source

WikiMark is built with Java.

Clone the repository and build with Gradle

gradle war

Running

You can deploy wikimark in any JEE container, although for the time being it's been officially tested only in Apache Tomcat.

Deploy build/wikimark.war on your container of choice. The root directory for wiki pages is ${user.home}/.wikimark.

You should configure security in the container in order to log in and create pages.

DO NOT run the server as root.

File format

Each page is stored in a single page. Metadata comes first, in plain text, and then the content:

title=The title
author=The author
keywords=keyword 1,keyword 2
CommonMark content

Example:

title=Test page
author=Martín Straus
keywords=java,wiki,commonmark
#Wikimark
This is the content of a sample page

Releases

No releases published

Packages

No packages published