mirror of
https://github.com/til-schneider/slim-wiki.git
synced 2025-01-17 04:38:24 +01:00
slim-wiki
A slim wiki based on PHP and markdown
Build instructions
Install grunt globally:
sudo npm install -g grunt-cli
Install grunt dependency in project:
cd src
npm install
Build client:
cd src
grunt
Build automatically on source changes (watch mode):
cd src
grunt watch
Installation instructions
- Build the project (see above)
- Copy the contents of the
dist
directory to your webspace. - Create a
config.xml
(copy and adjust the example). - Give write permissions to the server for directories
articles
anddata
.
Used libraries
- Bootstrap - Basic CSS styling
- Parsedown - PHP markdown parser
- highlight.js - JavaScript syntax highlighter
- CodeMirror - JavaScript in-browser code editor
Slim wiki is inspired by Wikitten.
Languages
JavaScript
68.5%
PHP
23.5%
CSS
5.8%
Less
2.2%