Участие в разработке BeamMP Docs

BeamMP использует Material for MkDocs в качестве своей темы. Это тема для MkDocs . Полную документацию можно найти на их соответствующих сайтах.

Начало работы

Чтобы внести свой вклад в эти документы, вы можете воспользоваться одним из двух подходов, изложенных ниже:

1. Редактировать необработанные файлы разметки

Редактирование необработанных файлов markdown — самый быстрый подход, который лучше всего подходит для быстрых правок, таких как орфография, грамматика или новые фрагменты контента. Однако этот подход требует предварительного знания markdown, поскольку вам нужно будет понимать, что даст ваш вклад.

Если вы предпочитаете именно этот подход, выполните следующие действия:

1. Нажмите «Изменить» на странице, которую вы хотите отредактировать.
2. Создайте форк проекта в своей учетной записи GitHub.
3. Внесите необходимые изменения.
4. Сохраните изменения в своем форке.
5. Подайте запрос на включение изменений в наш репозиторий здесь.

После того, как вы создали свой pull request, один из руководителей BeamMP Mod Team рассмотрит ваш pull request и либо одобрит его, либо запросит некоторые изменения. Если изменения были запрошены и вы их выполнили, мы повторно рассмотрим ваш pull request. Затем ваши изменения будут объединены в репозиторий и автоматически развернуты в рамках нашей непрерывной интеграции.

2. Вносите изменения с предварительным просмотром в реальном времени

Редактирование наших документов таким способом по-прежнему будет осуществляться по тому же принципу, что и в варианте 1, однако вы сможете предварительно просмотреть свои изменения.

1. Нажмите «Изменить» на странице, которую вы хотите отредактировать.
2. Создайте форк проекта в своей учетной записи GitHub.
3. Клонируйте проект локально.
4. Настройка материалов для MkDocs в соответствии с их руководством здесь.
5. Запустите mkdocs serve , чтобы запустить сервер документации с функцией перезагрузки в реальном времени, на который вы клонировали форк.
6. Внесите изменения, которые считаете нужными.
7. Сохраните изменения в своем форке.
8. Подайте запрос на включение изменений в наш репозиторий здесь.

Макет проекта

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.