eightm / javabackendstartguide Goto Github PK

Данный репозиторий содержит инструкцию по вкатыванию в Backend на Java. Инструкция описана на языке разметки Markdown. Для генерации использован статический генератор сайтов MkDocs. Тема - MkDocs Material

Руководство находится здесь:

https://EightM.github.io/JavaBackendStartGuide

Python 3.7+. Python можно поставить как из пакетного менеджера операционной системы, так и скачав дистрибутив с официального сайта.

Открываем терминал. Для начала, устанавливаем пакет для работы с виртуальными окружениями Python:

py -m pip install virtualenv

Создаем папку виртуального окружения:

py -m virtualenv venv

После чего, в корне проекта можно увидеть папку venv. Активируем виртуальное окружение:

.\venv\Scripts\activate

Устанавливаем в виртуальное окружение все необходимые для работы пакеты:

pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mike

Выполняем в терминале команду:

mkdocs serve

В результате будет запущен сайт с инструкцией по адресу 127.0.0.1:8000. Подробнее можно почитать ТУТ.

Принцип расширения документации не меняется. Пишем, используя Markdown , а MkDocs отображает в удобном для нас формате. Чтобы понять принцип, по которому строится навигация сайта, стоит обратить внимание на раздел nav в файле mkdocs.yml в корне репозитория. Верхний уровень навигации автоматически отображается в части сайта (см. св-во navigation.tabs) под заголовком. Визуальное отображение динамически подхватывает изменения, достаточно сохранить редактируемый markdown-файл, зажав в редакторе комбинацию CTRL + S. MkDocs имеет огромное количество плагинов, интересные подборки можно подсмотреть тут и, конечно же, тут. Наконец, я бы обратил внимание на разделы Setup и Reference в документации.

В папке github/workflows расположен файл ci.yml. В данном файле описана инструкция для платформы Github Pages. Как только изменения попадают в ветку develop, публикуется новая статическая версия сайта.