Git Product home page Git Product logo

slim-wiki's Introduction

slim-wiki

slim wiki is a fast and slim wiki based on PHP and markdown.

Want to use slim wiki?

Check out the demo website for more details and features.

slim wiki

Want to develop slim wiki?

Set up build environment

  1. Install node.js (this includes npm)

  2. Install grunt globally:

     sudo npm install -g grunt-cli
    
  3. Install grunt dependencies in project:

     cd src
     npm install
    

Note: node.js is only used by grunt for the build. Slim wiki uses PHP to run on server-side.

Build instructions

Build client:

cd src
grunt

Now link the project directory to a locally installed Apache Webserver with PHP and mod_rewrite enabled.

Go to the browser and open one of:

  • http://localhost/path/to/src/ - for the development version using the source JavaScript files.
  • http://localhost/path/to/dist/ - for the production version using compressed CSS and JavaScript.

Other build options

Build automatically on source changes (watch mode):

cd src
grunt watch

Build a release zip:

cd src
grunt release

Installation instructions

  1. Build the project (see above).
  2. Copy the contents of the dist directory to your webspace.
  3. Create a config.php (copy and adjust the example).
  4. Give write permissions to the server for the directory data (including subdirectories and files).

Used libraries

  • Bootstrap - Basic CSS styling.
  • Parsedown - PHP markdown parser.
  • prism - JavaScript syntax highlighter.
  • CodeMirror - JavaScript in-browser code editor.
  • Tocbot - JavaScript table of contents generator.
  • Vanilla JS - No jQuery. Instead standard DOM API in order to make things fast and slim.

Special thanks

  • Slim wiki is inspired by Wikitten. I have used some of their ideas, but technically slim wiki is a complete rewrite.
  • Thanks to Daring Fireball for inventing Markdown.
  • Thanks to GitHub for hosting this project and for some great enhancements to Markdown.

slim-wiki's People

Contributors

til-schneider avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.