1
0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-10 04:12:32 +01:00
docs/mkdocs.yml

66 lines
2.3 KiB
YAML
Raw Normal View History

2023-03-19 13:07:42 +01:00
extra:
#
# Change these macros if you wish to update the projects' name.
# Use {{ variable_name }} in .md files to reference a variable that you've declared here.
# For more information, read https://mkdocs-macros-plugin.readthedocs.io/en/latest/ .
2023-03-19 13:07:42 +01:00
#
project:
name: Fosscord # Tip: use {{ project_name.lower() }} to get the project name in lowercase.
domain: fosscord.com
repositories:
base_url: https://github.com/
server: fosscord/fosscord-server
client: fosscord/fosscord-client
missing_routes: fosscord/fosscord-missing-routes
main: &repo_url https://github.com/fosscord/fosscord # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
site:
name: &site_name Fosscord Documentation
description: &site_description "Documentation for Fosscord: a free open source selfhostable chat, voice and video discord-compatible platform"
edit_uri: &edit_uri https://github.com/fosscord/fosscord-docs/edit/master/docs/ # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
2023-03-19 13:07:42 +01:00
site_name: *site_name
repo_url: *repo_url
edit_uri: *edit_uri
site_description: *site_description
2021-05-14 12:10:07 +02:00
plugins:
2022-12-20 13:29:35 +01:00
- section-index
- search
2023-03-19 12:22:09 +01:00
- macros
2023-01-06 09:27:06 +01:00
- swagger-ui-tag:
extra_css: [assets/swagger.css]
docExpansion: none
filter: true
2021-05-14 11:23:35 +02:00
theme:
2022-12-20 13:29:35 +01:00
name: material
logo: assets/logo.svg
2023-01-06 09:27:06 +01:00
favicon: assets/favicon.svg
2022-12-20 13:29:35 +01:00
font: Open Sans
palette:
2022-12-31 09:32:28 +01:00
- media: "(prefers-color-scheme: light)"
primary: deep-orange
scheme: default
2022-12-20 13:29:35 +01:00
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
2022-12-31 09:32:28 +01:00
- media: "(prefers-color-scheme: dark)"
primary: deep-orange
scheme: slate
2022-12-20 13:29:35 +01:00
toggle:
icon: material/lightbulb
name: Switch to light mode
features:
- navigation.expand
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.indexes
- navigation.top
2021-05-15 13:08:36 +02:00
markdown_extensions:
2022-12-20 13:29:35 +01:00
- admonition
- pymdownx.details
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
extra_css: [assets/extra.css]