mirror of
https://github.com/BeamMP/Docs.git
synced 2025-07-01 15:35:56 +00:00
130 lines
3.6 KiB
YAML
130 lines
3.6 KiB
YAML
site_name: BeamMP Docs
|
||
site_url: https://docs.beammp.com/
|
||
site_description: This website serves as the new BeamMP Documentation site for general self serve support, guides and documentation. Best of all it is source available so you the community can help us to A. keep it up-to-date and B. providing the content you require.
|
||
repo_url: https://github.com/beammp/docs
|
||
repo_name: beammp/docs
|
||
edit_uri: edit/main/docs/
|
||
copyright: Copyright © 2019 - 2023 BeamMP Mod Team
|
||
|
||
theme:
|
||
language: en
|
||
name: material
|
||
logo: assets/logo.png
|
||
favicon: images/favicon.png
|
||
custom_dir: overrides
|
||
features:
|
||
- search.suggest
|
||
- search.highlight
|
||
- search.share
|
||
- content.code.annotate
|
||
- content.code.copy
|
||
- content.action.edit
|
||
- content.action.view
|
||
- navigation.instant
|
||
- navigation.footer
|
||
- navigation.tabs
|
||
- navigation.sections
|
||
- navigation.expand
|
||
- navigation.path
|
||
- toc.follow
|
||
icon:
|
||
repo: fontawesome/brands/github
|
||
palette:
|
||
- scheme: default
|
||
primary: white
|
||
accent: indigo
|
||
toggle:
|
||
icon: material/brightness-7
|
||
name: Switch to dark mode
|
||
- scheme: slate
|
||
primary: black
|
||
accent: indigo
|
||
toggle:
|
||
icon: material/brightness-4
|
||
name: Switch to light mode
|
||
|
||
extra_css:
|
||
- stylesheets/custom.css
|
||
extra_javascript:
|
||
- javascript/custom.js
|
||
extra:
|
||
consent:
|
||
title: Cookie consent
|
||
description: >-
|
||
We use cookies to recognize your repeated visits and preferences, as well
|
||
as to measure the effectiveness of our documentation and whether users
|
||
find what they're searching for. With your consent, you're helping us to
|
||
make our documentation better.
|
||
social:
|
||
- icon: fontawesome/brands/github
|
||
link: https://github.com/beammp
|
||
- icon: fontawesome/brands/twitter
|
||
link: https://twitter.com/beamng_mp
|
||
- icon: fontawesome/brands/discord
|
||
link: https://discord.gg/beammp
|
||
alternate:
|
||
- name: English
|
||
link: /en/
|
||
lang: en
|
||
- name: Deutsch
|
||
link: /de/
|
||
lang: de
|
||
- name: Français
|
||
link: /fr/
|
||
lang: fr
|
||
- name: Italiano
|
||
link: /it/
|
||
lang: it
|
||
- name: Pусский
|
||
link: /ru/
|
||
lang: ru
|
||
homepage: /en
|
||
|
||
plugins:
|
||
- search
|
||
- social
|
||
- tags
|
||
- git-revision-date-localized:
|
||
enable_creation_date: true
|
||
|
||
markdown_extensions:
|
||
- attr_list
|
||
- pymdownx.emoji:
|
||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||
- pymdownx.highlight:
|
||
anchor_linenums: true
|
||
line_spans: __span
|
||
pygments_lang_class: true
|
||
- pymdownx.inlinehilite
|
||
- pymdownx.snippets
|
||
- pymdownx.superfences
|
||
|
||
nav:
|
||
- Home: en/index.md
|
||
- Getting started:
|
||
- Playing BeamMP:
|
||
- Installation: en/game/getting-started.md
|
||
- Customizing your setup: en/game/tailoring.md
|
||
- Using BeamMP: en/game/playing.md
|
||
- Running a Server:
|
||
- Installation: en/server/create-a-server.md
|
||
- Server Manual: en/server/manual.md
|
||
- Support:
|
||
- Game FAQ: en/support/game-faq.md
|
||
- Server FAQ: en/support/server-faq.md
|
||
- Guides:
|
||
- en/guides/index.md
|
||
- Mod Creation:
|
||
- UI Apps: en/guides/modding/ui-apps.md
|
||
- IMGUI Windows: en/guides/modding/imgui-windows.md
|
||
- Lua Mods: en/guides/modding/lua-mods.md
|
||
- Resource Creation:
|
||
- UI Apps: en/guides/resources/getting-started.md
|
||
- BeamNG Documentation:
|
||
- Installation: en/beamng/index.md
|
||
- Scripting Reference:
|
||
- Mod (In-Game): en/scripting/mod/index.md
|
||
- Server: en/scripting/server/index.md
|
||
- Contributing:
|
||
- Getting Started: en/contributing.md |