gotosocial/mkdocs.yml

66 lines
1.9 KiB
YAML

site_name: GoToSocial Documentation
theme: readthedocs
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
extra_css:
- assets/css/swagger-ui.css
nav:
- "Home": "index.md"
- "FAQ": "faq.md"
- "User Guide":
- "user_guide/posts.md"
- "user_guide/user_panel.md"
- "user_guide/custom_css.md"
- "user_guide/password_management.md"
- "user_guide/rss.md"
- "Installation Guide":
- "installation_guide/index.md"
- "installation_guide/binary.md"
- "installation_guide/docker.md"
- "installation_guide/nginx.md"
- "installation_guide/apache-httpd.md"
- "installation_guide/caddy.md"
- "installation_guide/third_party.md"
- "installation_guide/websocket.md"
- "installation_guide/advanced.md"
- "Configuration":
- "configuration/index.md"
- "configuration/general.md"
- "configuration/database.md"
- "configuration/web.md"
- "configuration/instance.md"
- "configuration/accounts.md"
- "configuration/media.md"
- "configuration/storage.md"
- "configuration/statuses.md"
- "configuration/letsencrypt.md"
- "configuration/oidc.md"
- "configuration/smtp.md"
- "configuration/syslog.md"
- "configuration/advanced.md"
- "Admin":
- "admin/admin_panel.md"
- "admin/cli.md"
- "admin/backup_and_restore.md"
- "Federation":
- "federation/index.md"
- "federation/glossary.md"
- "federation/security.md"
- "federation/behaviors/outbox.md"
- "federation/behaviors/conversation_threads.md"
- "federation/behaviors/request_throttling.md"
- "API Documentation":
- "api/swagger.md"
- "api/ratelimiting.md"
- "api/throttling.md"