Download the PHP package doctordanila/script-doc without Composer

On this page you can find all versions of the php package doctordanila/script-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of doctordanila/script-doc

Informations about the package script-doc

DoctorDanila/ScriptDoc

Пакет для автоматической генерации веб-интерфейса документации на основе Markdown-файлов. Подходит для любых PHP-проектов: от простых скриптов до фреймворков Yii и Laravel.

Возможности

Где размещён

Установка

Установите пакет через Composer:

Как подключить в проект

Обычный PHP-проект

  1. Подключите автозагрузку Composer и настройте контроллер документации.
  2. Вызовите handleRequest() в точке входа (например, index.php).
  3. Настройте веб-сервер так, чтобы все запросы к /docs/* направлялись на этот скрипт.

Пример public/index.php:

Для локального тестирования используйте встроенный сервер PHP:

Теперь документация доступна по адресу http://localhost:8000/docs.

Подключение к Yii (Yii2)

Создайте модуль для документации:

  1. Файл modules/docs/Module.php:

  2. Файл modules/docs/controllers/DefaultController.php:

  3. Зарегистрируйте модуль в конфигурации config/web.php:

Теперь документация будет доступна по URL /docs.

Подключение к Laravel

  1. Создайте сервис-провайдер и маршрут.

  2. В файле app/Providers/DocServiceProvider.php:

  3. Зарегистрируйте провайдер в config/app.php (секция providers):

  4. Настройте веб-сервер (Nginx) так, чтобы запросы к /docs/* не обрабатывались Laravel-роутингом, а направлялись напрямую на точку входа, либо создайте простой роут в routes/web.php:

После этого документация станет доступна по /docs.

Команда для просмотра документации

Если вы используете встроенный сервер PHP, запустите команду:

Затем откройте http://localhost:8000/docs. Маршрут /docs будет автоматически перехвачен контроллером пакета.

Настройка пакета при подключении

Класс Controller предоставляет цепочку методов для конфигурации:

Метод Описание
setProjectName() Название проекта (отображается в заголовке страницы)
setDocsDir() Абсолютный путь к папке с Markdown-документацией
setRoutePrefix() URL-префикс, по которому будет доступна документация (по умолчанию /docs)
setProjectRootDir() Корневая директория проекта (по умолчанию – родительская от docsDir)
setSwaggerPath() Внешняя ссылка на Swagger-описание API (опционально)

Все методы возвращают текущий экземпляр Controller, позволяя строить цепочку вызовов.

Известные проблемы

Рекомендации по процессу работы

  1. Структура документации. Держите основные разделы в отдельных папках внутри docs/ и обязательно добавляйте файл README.md для каждого раздела – он будет отображаться при переходе в соответствующую папку.
  2. Именование файлов. Старайтесь придерживаться нижнего регистра и избегайте специальных символов в названиях, чтобы упростить навигацию.
  3. Интеграция с CI/CD. Добавьте шаг в процесс сборки, который проверяет наличие и корректность Markdown-файлов (например, линтер Markdown).
  4. Безопасность. Документация доступна публично. Не размещайте в папке docs/ конфиденциальную информацию. При необходимости настройте ограничение доступа на уровне веб-сервера.
  5. Альтернативный веб-сервер. Для production-окружения рекомендуется использовать Nginx или Apache с rewrite-правилами, направляющими запросы к /docs/* на ваш PHP-скрипт, минуя основной роутинг фреймворка, чтобы избежать накладных расходов.

All versions of script-doc with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
cebe/markdown Version ^1.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package doctordanila/script-doc contains the following files

Loading the files please wait ...