Буривух - блокнот для записей

Установка

Самый удобный способ установки - это через composer. Надо выполнить в консоли в директории вашего приложения

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

или добавить

"zabachok/yii2-burivuh": "*"

в раздел "require" вашего composer.json и выполнить composer update.

Выполните миграцию, что бы создать необходимые таблицы в базе:

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

Включение

Добавьте в конфиг вашего приложения:

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

и в автозапуск:

'bootstrap' => [..., 'burivuh'],

Настройка

  1. db - имя компонента базы данных:
    'burivuh' => [
    					'class' => 'zabachok\burivuh\Module',
    					'db'=>'db',
    					...
    					],
    				
  2. usernameCallback - анонимная функция для получения имени пользователя:
    'burivuh' => [
    					'class' => 'zabachok\burivuh\Module',
    					'usernameCallback' =>function($user_id)
    					{
    					$user = \common\models\user\User::findIdentity($user_id);
    					return is_null($user) ? 'Неизвестно' : $user->username;
    					},
    					...
    					],
    				
  3. route - вы можете использовать свой путь к модулю. Например:
    'burivuh' => [
    					'class' => 'zabachok\burivuh\Module',
    					'route' => 'wiki',
    					...
    					],
    				

    Будет генерировать пути example.com/wiki/category/doc

  4. accessRules - эта опция конфигурирует компонент AccessControl::rules.
    'burivuh' => [
    					'class' => 'zabachok\burivuh\Module',
    					'accessRules' => [
    					[
    					'allow' => true,
    					'roles' => ['?'],
    					],
    					],
    					...
    					],
    				

Использование

Откройте страничку: http://your-site.com/burivuh
Вы можете создавать, изменять и удалять категории и документы. Все действия доступны только авторизованным пользователям.

Горячие клавиши

В списке

Стрелки вверх и вних - перемещают курсор.
Enter - открыть категорию или документ.
Backspace - вернуться на уровень назад.

В просмотре документа

Ctrl + e - редактировать документ

В редактировании документа

Ctrl + s - сохранить
Shift + Enter - новая строка
Tab - четыре пробела

Форматирование текста Ctrl + h - сделать эту строку заголовком

Скриншоты

Категория

Категория

Просмотр документа

Просмотр документа

Редактирование документа

Редактирование документа

Удаление документа

Удаление документа

История редактирования документа

История редактирования документа

Разница между ревизиями

Разница между ревизиями