diff options
| author |  Daenney <daenney@users.noreply.github.com> | 2023-02-20 23:09:17 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2023-02-20 23:09:17 +0100 |
| commit | 40eea3b4097019a5eaca65968cc249ed564e0023 (patch) | |
| tree | 263e1c7203aac205d676f5d016262f3c0fb1bcdf /mkdocs.yml | |
| parent | [docs] correct swagger docs (#1543) (diff) | |
| download | gotosocial-40eea3b4097019a5eaca65968cc249ed564e0023.tar.xz | |
[feature] Use Material theme for docs (#1535)
* [feature] Use Material theme for docs
This changes the theme to use Material with the slate (dark) theme and
the accent colour set to orange. It also replaces the swagger plugin
with one that works correctly with the Material theming.
* Add theme by @f0x52
Co-authored-by: f0x52 <f0x@cthu.lu>
* Enable social cards
The dependencies for cairosvg and pillow can be satisfied on RTD, so
this adds them to our requirements.txt and enables the social plugin.
This generates opengraph and twitter card tags as well as fancy preview
images in GTS colour style for platforms that show that as part of link
previews.
* Update Conda environment.yml
* update theme for swagger, basic light theme option
* dark mode mobile header bg color
---------
Co-authored-by: f0x52 <f0x@cthu.lu>
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 38 |
1 files changed, 29 insertions, 9 deletions
diff --git a/mkdocs.yml b/mkdocs.yml index b50b9186f..97b65a611 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,19 +1,39 @@ site_name: GoToSocial Documentation -theme: readthedocs +theme: + name: material + language: en + font: false + features: + - header.autohide + palette: + - scheme: slate + toggle: + icon: material/brightness-7 + name: Switch to light mode + - scheme: default + toggle: + icon: material/brightness-4 + name: Switch to dark mode repo_url: https://github.com/superseriousbusiness/gotosocial edit_uri: edit/main/docs/ copyright: GoToSocial is licensed under the GNU AGPL v3 LICENSE. Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org plugins: - - render_swagger - -markdown_extensions: - - markdown.extensions.admonition - -extra_javascript: - - assets/js/swagger-ui-bundle.js + - search: + lang: en + - social: + cards: true + cards_color: + fill: "#fd6a00" + text: "#fafaff" + - swagger-ui-tag: + supportedSubmitMethods: [] + syntaxHighlightTheme: obsidian extra_css: - - assets/css/swagger-ui.css + - assets/css/colours.css + +markdown_extensions: + - admonition nav: - "Home": "index.md" |