Burivuh - notepad with markdown editor

Simple notepad with markdown editor for yii2 Все это на русском

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist zabachok/yii2-burivuh "*"

or add

"zabachok/yii2-burivuh": "*"

to the require section of your composer.json file.

Run module migration:

php yii migrate --migrationPath=@vendor/zabachok/yii2-burivuh/migrations

Activating

Add to you config file:

'modules' => [
    ...
    'burivuh' => [
        'class' => zabachok\burivuh\Module::class,
    ],
]

and to bootstrapping:

'bootstrap' => [..., zabachok\burivuh\Bootstrap::class],

Options

1. db - name of database component:

   'burivuh' => [
       'class' => zabachok\burivuh\Module::class,
       'db'=>'db',
   ...
   ],

2. usernameCallback - anonymous function for generate username:

   'burivuh' => [
       'class' => zabachok\burivuh\Module::class,
       'usernameCallback'  =>function($user_id)
           {
               $user = \common\models\user\User::findIdentity($user_id);
               return is_null($user) ? 'Undefined' : $user->username;
           },
   ...
   ],

3. route - you can use custom route to this module. For example:

   'burivuh' => [
       'class' => zabachok\burivuh\Module::class,
       'route' => 'wiki',
   ...
   ],

   It will be generate links like example.com/wiki/doc/mydoc

4. accessRules - this option configuring AccessControl::rules component. For example:

   'burivuh' => [
       'class' => zabachok\burivuh\Module::class,
       'as access' => [
           'class' => yii\filters\AccessControl::className(),
           'rules' => [
               [
                   'allow' => true,
                   'roles' => ['?'],
               ],
           ],
       ],
   ...
   ],

Usage

Open url: http://your-site.com/burivuh
You can create, update and delete categories and documents. All actions is available only for authorized users.

Hot keys

In list

Arrow up and arrow down - moving up and down in list
Enter - open dir or file
Backspace - up in filesystem tree

In view

Ctrl + e - edit the document

In write

Ctrl + s - save document
Shift + Enter - new line
Tab - four spaces

Text formatting Ctrl + h - make this line a header