Импорт статической документации

Этот веб-сайт поддерживает как встроенную Markdown, так и готовую статическую документацию. На этой странице объясняется механизм публикации; это не означает, что любой инженерный проект уже имеет руководство.

Собственная уценка

Создайте docs/my-project/index.md и напишите Markdown с заголовком в начале. Добавьте такие страницы, как docs/my-project/setup/index.md. Ссылка из индекса с [Setup](setup/) и обратно с [Overview](../).

Добавьте проект в индекс документации. Каждый проект может иметь собственную небольшую навигацию или ссылки в Markdown.

Импортированный HTML

Создавайте общедоступную документацию локально с помощью Documenter.jl, MkDocs или другого статического генератора. Настройте общедоступный URL-адрес https://ahmelkholy.github.io/docs/my-project/ и убедитесь, что в его ресурсах используются относительные ссылки или именно этот префикс.

Скопируйте только сгенерированный общедоступный вывод в static-docs/my-project/. Зафиксируйте это вместе с сайтом. Перехватчик пост-записи Jekyll копирует этот каталог побайтно в _site/docs/my-project/ после завершения работы Jekyll. Жидкость и лицевая сторона в импортированных файлах не интерпретируются. Активы с префиксом подчеркивания сохраняются.

Не создавайте также собственный каталог docs/my-project/: сборка отклоняет коллизии. Символические ссылки и скрытые файлы отклоняются. Используйте другое имя проекта, чтобы разделить две формы.

Рабочий процесс развертывания никогда не извлекает другой репозиторий. Частные источники, блокноты с личными данными, учетными данными и местными доказательствами не должны включаться в генерируемые выходные данные.

Предварительный просмотр и проверка

Запустите bundle exec jekyll build, затем python3 scripts/check_site.py. Для предварительного просмотра запустите bundle exec jekyll serve; перезапустите его после замены импортированного пакета, поскольку этот входной каталог исключен из средства наблюдения за файлами Jekyll.

Откройте рабочий статический пример или вернитесь к авторству .