Docs init

This commit is contained in:
Radim Lipovčan 2024-09-02 18:43:04 +02:00
parent 7b95368de2
commit 7e94f5c6b3
4 changed files with 74 additions and 0 deletions

1
docs/index.md Normal file
View File

@ -0,0 +1 @@
# PlayerServers Overview

1
docs/install.md Normal file
View File

@ -0,0 +1 @@
# Installation

1
docs/media/index.md Normal file
View File

@ -0,0 +1 @@
# upload media here

71
mkdocs.yml Normal file
View File

@ -0,0 +1,71 @@
# Site name
site_name: PlayerServers documentation
# Navigation menu
nav:
- Home: index.md
- Installation: install.md
# Theme
theme:
feaures:
- tabs
name: material
icon:
logo: material/cloud
font:
text: Ubuntu
code: Ubuntu Mono
static_templates:
- 404.html
# Extensions
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.attr_list
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
# - pymdownx.highlight:
# linenums_style: pymdownx-inline
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- search
- pdf-export:
verbose: True
media_type: print
combined: True
combined_output_path: pdf/combined.pdf
enabled_if_env: ENABLE_PDF_EXPORT
- minify:
minify_html: true
- git-revision-date-localized:
type: datetime