Skip to content

esnya/mew

Repository files navigation

Mew

Build Status Coverage Status VersionEye

Markdown Easy Wiki.

Pages are written by Markdown(PHP Markdown Extra).

Usage

  1. Clone this repository.

    $ git clone https://github.com/ukatama/mew
    $ cd mew
  2. Install dependencies by composer.

    $ composer install
  3. Copy default config.

    $ cp config/wiki.default.php config/wiki.php
  4. Allow HTTP access and PHP execution.

    • Copy into document root of Apache.

    • Run PHP built in web server.

      $ php -S localhosr:80

Docker

  1. Clone this repository.

    $ git clone https://github.com/ukatama/mew
  2. Build image.

    $ docker build -t ukatama/mew mew
  3. Make config.

    $ vi /path/to/config/wiki.php
  4. Run container.

    $ docker run -d --name mew -p 80:80 -v /path/to/config:/var/www/html/config ukatama/mew

Features

  • Create/Read/Update/Remove pages
  • Upload attached files
  • Export (download) to Markdown
  • Import (upload) from Markdown

ToDo

  • Documentations
  • Password
  • Plugin system

Bugs, Issues, PR

Create new issue or pull request.

License

  • MIT License