mirror of
https://github.com/til-schneider/slim-wiki.git
synced 2025-08-08 01:26:31 +02:00
Linking to demo in readme
This commit is contained in:
45
README.md
45
README.md
@@ -1,18 +1,29 @@
|
|||||||
slim-wiki
|
slim-wiki
|
||||||
=========
|
=========
|
||||||
|
|
||||||
A slim wiki based on PHP and markdown
|
slim wiki is a fast and slim wiki based on PHP and markdown.
|
||||||
|
|
||||||
|
|
||||||
|
Want to use slim wiki?
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
Check out the **[demo website](http://slim-wiki.murfman.de/)** for more details and features.
|
||||||
|
|
||||||
|
[](http://slim-wiki.murfman.de/)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Build instructions
|
Want to develop slim wiki?
|
||||||
------------------
|
--------------------------
|
||||||
|
|
||||||
|
|
||||||
|
### Build instructions
|
||||||
|
|
||||||
Install grunt globally:
|
Install grunt globally:
|
||||||
|
|
||||||
sudo npm install -g grunt-cli
|
sudo npm install -g grunt-cli
|
||||||
|
|
||||||
Install grunt dependency in project:
|
Install grunt dependencies in project:
|
||||||
|
|
||||||
cd src
|
cd src
|
||||||
npm install
|
npm install
|
||||||
@@ -29,21 +40,27 @@ Build automatically on source changes (watch mode):
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
Installation instructions
|
### Installation instructions
|
||||||
-------------------------
|
|
||||||
|
|
||||||
1. Build the project (see above)
|
1. Build the project (see above).
|
||||||
2. Copy the contents of the `dist` directory to your webspace.
|
2. Copy the contents of the `dist` directory to your webspace.
|
||||||
3. Create a `config.xml` (copy and adjust the example).
|
3. Create a `config.xml` (copy and adjust the example).
|
||||||
4. Give write permissions to the server for directories `articles` and `data`.
|
4. Give write permissions to the server for directories `articles` and `data`.
|
||||||
|
|
||||||
|
|
||||||
Used libraries
|
|
||||||
--------------
|
|
||||||
|
|
||||||
- [Bootstrap](http://getbootstrap.com/) - Basic CSS styling
|
### Used libraries
|
||||||
- [Parsedown](https://github.com/erusev/parsedown/) - PHP markdown parser
|
|
||||||
- [prism](http://prismjs.com/) - JavaScript syntax highlighter
|
|
||||||
- [CodeMirror](https://codemirror.net/) - JavaScript in-browser code editor
|
|
||||||
|
|
||||||
Slim wiki is inspired by [Wikitten](https://github.com/victorstanciu/Wikitten).
|
- [Bootstrap](http://getbootstrap.com/) - Basic CSS styling.
|
||||||
|
- [Parsedown](https://github.com/erusev/parsedown/) - PHP markdown parser.
|
||||||
|
- [prism](http://prismjs.com/) - JavaScript syntax highlighter.
|
||||||
|
- [CodeMirror](https://codemirror.net/) - JavaScript in-browser code editor.
|
||||||
|
- [Vanilla JS](http://vanilla-js.com/) - No jQuery. Instead standard DOM API in order to make things fast and slim.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Special thanks
|
||||||
|
|
||||||
|
- Slim wiki is inspired by [Wikitten](https://github.com/victorstanciu/Wikitten). I have used some of their ideas, but technically slim wiki is a complete rewrite.
|
||||||
|
- Thanks to Daring Fireball for inventing [Markdown](https://daringfireball.net/projects/markdown/syntax).
|
||||||
|
- Thanks to GitHub for hosting this project and for some great [enhancements to Markdown](https://help.github.com/articles/github-flavored-markdown).
|
||||||
|
Reference in New Issue
Block a user