summaryrefslogtreecommitdiff
path: root/mkdocs.yml
blob: b50b9186fd36535798c07b185e904e3be0c6fa11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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/settings.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"
      - "configuration/observability.md"
  - "Admin":
      - "admin/settings.md"
      - "admin/cli.md"
      - "admin/backup_and_restore.md"
  - "Federation":
      - "federation/index.md"
      - "federation/glossary.md"
      - "federation/federating_with_gotosocial.md"
  - "API Documentation":
      - "api/swagger.md"
      - "api/ratelimiting.md"
      - "api/throttling.md"