docs.foss.global/mkdocs/mkdocs.yml

154 lines
3.9 KiB
YAML
Raw Normal View History

2024-04-30 16:18:56 +00:00
# Project information
site_name: docs.foss.global
site_url: https://docs.foss.global/
site_author: Task Venture Capital GmbH
site_description: >-
Write your documentation in Markdown and create a professional static site in
minutes searchable, customizable, in 60+ languages, for all devices
# Repository
repo_name: foss.global/docs.foss.global
repo_url: https://code.foss.global/foss.global/docs.foss.global
2024-04-30 17:30:19 +00:00
edit_uri: _edit/master/mkdocs/docs/
2024-04-30 16:18:56 +00:00
# Copyright
2024-04-30 17:30:19 +00:00
copyright: "Copyright &copy; since 2014: <a href='https://task.vc/'>Task Venture Capital GmbH</a><br><a href='https://legal.task.vc/'>Legal Info / Impressum</a>"
2024-04-30 16:18:56 +00:00
# Configuration
theme:
name: material
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
# - content.code.select
# - content.footnote.tooltips
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
# - navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/link
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
favicon: assets/favicon.png
icon:
logo: logo
# Plugins
plugins:
- blog
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
# Additional configuration
extra:
generator: false
status:
new: Recently added
deprecated: Deprecated
social:
2024-04-30 17:30:19 +00:00
- icon: fontawesome/solid/code
link: https://code.foss.global/
2024-04-30 16:18:56 +00:00
- icon: fontawesome/brands/docker
2024-04-30 17:30:19 +00:00
link: https://registry.foss.global/
2024-04-30 16:18:56 +00:00
- icon: fontawesome/brands/mastodon
2024-04-30 17:30:19 +00:00
link: https://mtd.task.vc/@foss_global
2024-04-30 16:18:56 +00:00
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
auto_append:
- includes/mkdocs.md
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Page tree
nav:
2024-05-06 09:41:25 +00:00
- Home: index.md
2024-05-16 11:55:33 +00:00
- serve.zone:
- Introduction: serve.zone.md
- modules:
- module 1: serve.zone/test.md
- module 2: serve.zone/test.md
2024-05-06 09:41:25 +00:00
- Awesome Third Party: awesome-thirdparty.md