Simple wiki based on locally stored markdown files.
- retrieve markdown files in json with GET
- create new markdown document with POST
- add embedded Jetty server to make standalone app
- view markdown documents rendered as html
- version control md documents with git
- integrate
solrLucene to provide search capabilities - integrate Spring Security
-
GET
mdwiki/markdown/<document>.jsonwheredocumentis without extension. -
POST
mdwiki/markdownwith body{ "author" : <author>, "name" : <filename>, "content" : <file-content> }curl
curl -X POST -H "Content-Type: application/json" -d '{"name":"post-test","author":"post-author","content":"post-content"}' http://localhost:8080/mdwiki/markdown
WIKI_ROOT=~/wiki/markdowndirectory the app looks for markdown files. Flat, subirecties are not scannedDEFAULT_ENCODING=UTF-8encoding of markdown documentsLINE_SEPARATOR=\nMARKDOWN_EXTENSION=mdDEFAULT_AUTHOR=default-author
override with -D<parameter>=<value> at startup
mvn tomcat:run
This will install every dependencies both for the backend and frontend.
Afterwards you can reach the app in the browser on localhost:8080/kicsikrumpli
The following commands should be given out in the webappsrc folder
npm install
gulp watch
Upon changing/adding any javascript, html file in the app folder it will bundle them together into the build.js file.