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.
2023-03-19 15:06:11 +01:00
# For more information, read https://mkdocs-macros-plugin.readthedocs.io/en/latest/ .
2023-03-19 13:07:42 +01:00
#
2023-03-19 15:06:11 +01:00
project :
2023-03-30 16:13:55 +02:00
name: Spacebar # Tip : use {{ project_name.lower() }} to get the project name in lowercase.
domain : spacebar.chat
2023-03-19 15:06:11 +01:00
repositories :
2023-03-30 18:33:23 +02:00
base_url : https://github.com
2023-03-30 16:13:55 +02:00
server : spacebarchat/server
client : spacebarchat/client
missing_routes : spacebarchat/missing-routes
main : &repo_url https://github.com/spacebarchat/spacebarchat # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
2023-03-19 15:06:11 +01:00
site :
2023-03-30 16:13:55 +02:00
name : &site_name Spacebar Documentation
description : &site_description "Documentation for Spacebar: a free open source selfhostable chat, voice and video discord-compatible platform"
edit_uri : &edit_uri https://github.com/spacebarchat/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)"
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)"
scheme : slate
2023-04-04 13:46:44 +02:00
primary : indigo
2022-12-20 13:29:35 +01:00
toggle :
icon : material/lightbulb
name : Switch to light mode
2023-04-28 14:26:57 +02:00
custom_dir : docs/assets/overrides
2022-12-20 13:29:35 +01:00
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
2022-12-29 07:28:30 +01:00
- pymdownx.tabbed :
alternate_style : true
2022-12-22 11:53:24 +01:00
extra_css : [ assets/extra.css]