Док-документ Пусть все документы будут красивыми.

Подготовка

1 Этому плагину требуется обычный доступ в интернет через VPN, подойдёт «Blue Lantern» или «Sufeng», поскольку он публикуется на зарубежном Packagist.

Адреса git-проектов:
Packagist: https://packagist.org/packages/aliang/doc
Git-код Cloud: https://git.oschina.net/mrmiao/DocSite (содержит документацию по использованию).

Установка
В корневом каталоге выполните:

• composer require aliang/doc.
  Если плагин уже установлен и требуется обновление, выполните:
• composer update aliang/doc.
  Добавьте сервис-провайдера в config/app.php:
• ALiang\Doc\DocServiceProvider::class (для версии 5.1 и выше);
• «ALiang\Doc\DocServiceProvider» (для версии 5.0).
  Добавьте фасад в config/app.php:
• 'Doc' => ALiang\Doc\Facades\Doc::class (для версии 5.1 и выше);
• 'Doc' => 'ALiang\Doc\Facades\Doc' (для версии 5.0 и выше).
  Сгенерируйте конфигурационный файл:
• php artisan vendor:publish.
  Проверьте, появились ли новые файлы в следующих папках:
• public — папка md;
• config — файл doc.php;
• resources/views — папка vendor/doc.

Использование
В контроллере:

• используйте Doc (верхний уровень фасада);
• в функции index(Request $request) верните Doc::render().

Изменение шаблона
Измените файл resources/views/doc/doc.balde.php.

Добавление документации
Создайте новый файл test.md в папке public.
Добавьте конфигурацию в файл config/doc.php:
[ "id" => 3, "uid" => "server", "title" => "2", "list" => [ [ "id" => 4, "uid" => "server1", "title" => "2.1" ], [ "id" => 4, "uid" => "test", "title" => "2.2测试" ] ] ].
Обновите страницу, чтобы увидеть изменения. Для создания файлов используйте онлайн-редактор или редактор на вашем компьютере.

Изменение типа файла и каталога
Внесите изменения в файл config/doc.php:

• extension — ".md";
• doc_path — "/md/".

Примечание
Файлы доступны только через запросы GET и являются общедоступными. Частные файлы пока не поддерживаются.

Спасибо за внимание!

Пожалуйста, обратите внимание, что некоторые фрагменты текста могут быть переведены неточно из-за особенностей исходного текста.