mirror of
https://github.com/BeamMP/Docs.git
synced 2025-06-30 23:15:34 +00:00
Added plugins and initial theming
This commit is contained in:
parent
90a18ff752
commit
96c48e81f4
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@ -20,5 +20,5 @@ jobs:
|
||||
path: .cache
|
||||
restore-keys: |
|
||||
mkdocs-material-
|
||||
- run: pip install mkdocs-material
|
||||
- run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin "mkdocs-material[imaging]"
|
||||
- run: mkdocs gh-deploy --force
|
||||
|
70
.gitignore
vendored
Normal file
70
.gitignore
vendored
Normal file
@ -0,0 +1,70 @@
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
env/
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
node_modules/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
package*.json
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*,cover
|
||||
.hypothesis/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
# IPython Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# pyenv
|
||||
.python-version
|
||||
|
||||
# virtualenv
|
||||
venv/
|
||||
ENV/
|
||||
|
||||
# MkDocs documentation
|
||||
site*/
|
BIN
docs/assets/logo.png
Normal file
BIN
docs/assets/logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
0
docs/javascript/custom.js
Normal file
0
docs/javascript/custom.js
Normal file
0
docs/stylesheets/custom.css
Normal file
0
docs/stylesheets/custom.css
Normal file
72
mkdocs.yml
72
mkdocs.yml
@ -1,3 +1,75 @@
|
||||
site_name: BeamMP Docs
|
||||
site_url: https://docs.beammp.com
|
||||
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
|
||||
features:
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- search.share
|
||||
- content.code.annotate
|
||||
- navigation.footer
|
||||
- content.action.edit
|
||||
- content.action.view
|
||||
- navigation.tabs
|
||||
- navigation.sections
|
||||
- navigation.expand
|
||||
- navigation.path
|
||||
- toc.follow
|
||||
icon:
|
||||
repo: fontawesome/brands/github
|
||||
|
||||
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
|
||||
|
||||
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
|
Loading…
x
Reference in New Issue
Block a user