154 lines
3.9 KiB
YAML
154 lines
3.9 KiB
YAML
# 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
|
||
edit_uri: _edit/master/mkdocs/docs/
|
||
|
||
# Copyright
|
||
copyright: "Copyright © since 2014: <a href='https://task.vc/'>Task Venture Capital GmbH</a><br><a href='https://legal.task.vc/'>Legal Info / Impressum</a>"
|
||
|
||
# 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:
|
||
- icon: fontawesome/solid/code
|
||
link: https://code.foss.global/
|
||
- icon: fontawesome/brands/docker
|
||
link: https://registry.foss.global/
|
||
- icon: fontawesome/brands/mastodon
|
||
link: https://mtd.task.vc/@foss_global
|
||
|
||
# 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:
|
||
- Home: index.md
|
||
- serve.zone:
|
||
- Introduction: serve.zone.md
|
||
- modules:
|
||
- module 1: serve.zone/test.md
|
||
- module 2: serve.zone/test.md
|
||
- Awesome Third Party: awesome-thirdparty.md |