okhttp

1
site_name: OkHttp
2
site_url: https://square.github.io/okhttp/
3
repo_name: OkHttp
4
repo_url: https://github.com/square/okhttp
5
site_description: "Square’s meticulous HTTP client for the JVM, Android, and GraalVM"
6
site_author: Square, Inc.
7
remote_branch: gh-pages
8
edit_uri: ""
9

10
copyright: 'Copyright © 2022 Block, Inc.'
11

12
theme:
13
  name: 'material'
14
  favicon: assets/images/icon-square.png
15
  logo: assets/images/icon-square.png
16
  palette:
17
    - media: "(prefers-color-scheme: light)"
18
      scheme: default
19
      primary: teal
20
      accent: blue
21
      toggle:
22
        icon: octicons/sun-24
23
        name: "Switch to Dark Mode"
24
    - media: "(prefers-color-scheme: dark)"
25
      scheme: slate
26
      primary: teal
27
      accent: blue
28
      toggle:
29
        icon: octicons/moon-24
30
        name: "Switch to Light Mode"
31
  features:
32
  - navigation.tabs
33

34
extra_css:
35
  - 'assets/css/app.css'
36

37
markdown_extensions:
38
  - smarty
39
  - footnotes
40
  - meta
41
  - toc:
42
      permalink: true
43
  - attr_list
44
  - pymdownx.betterem:
45
      smart_enable: all
46
  - pymdownx.caret
47
  - pymdownx.emoji:
48
      emoji_index: !!python/name:materialx.emoji.twemoji
49
      emoji_generator: !!python/name:materialx.emoji.to_svg
50
  - pymdownx.inlinehilite
51
  - pymdownx.magiclink
52
  - pymdownx.smartsymbols
53
  - pymdownx.superfences
54
  - pymdownx.tilde
55
  - pymdownx.tabbed:
56
      alternate_style: true
57
  - tables
58

59
plugins:
60
  - search
61
  - redirects:
62
      redirect_maps:
63
        # Redirect all feature pages to features/*
64
        'caching.md': 'features/caching.md'
65
        'calls.md': 'features/calls.md'
66
        'connections.md': 'features/connections.md'
67
        'events.md': 'features/events.md'
68
        'https.md': 'features/events.md'
69
        'interceptors.md': 'features/interceptors.md'
70
        'r8_proguard.md': 'features/r8_proguard.md'
71
        # Redirect all Security pages to security/*
72
        'security.md': 'security/security.md'
73
        'security_providers.md': 'security/security_providers.md'
74
        'tls_configuration_history.md': 'security/tls_configuration_history.md'
75
        # Redirect all changelog pages to changelog/*
76
        'changelog.md': 'changelogs/changelog.md'
77
        'upgrading_to_okhttp_4.md': 'changelogs/upgrading_to_okhttp_4.md'
78
        'changelog_3x.md': 'changelogs/changelog_3x.md'
79
        'changelog_2x.md': 'changelogs/changelog_2x.md'
80
        'changelog_1x.md': 'changelogs/changelog_1x.md'
81
        # Redirect all contributing pages to contribute/*
82
        'contributing.md': 'contribute/contributing.md'
83
        'code_of_conduct.md': 'contribute/code_of_conduct.md'
84
        'concurrency.md': 'contribute/concurrency.md'
85
        'debug_logging.md': 'contribute/debug_logging.md'
86

87
nav:
88
  - 'Overview':
89
    - 'Overview': index.md
90
    - 'Stack Overflow': https://stackoverflow.com/questions/tagged/okhttp?sort=active
91
  - 'Features':
92
    - 'Calls': features/calls.md
93
    - 'Caching': features/caching.md
94
    - 'Connections': features/connections.md
95
    - 'Events': features/events.md
96
    - 'HTTPS': features/https.md
97
    - 'Interceptors': features/interceptors.md
98
    - 'R8/Proguard': features/r8_proguard.md
99
  - 'Recipes': recipes.md
100
  - 'Security':
101
    - 'Security': security/security.md
102
    - 'Providers': security/security_providers.md
103
    - 'Configuration History': security/tls_configuration_history.md
104
  - 'Works with OkHttp': works_with_okhttp.md
105
  - 'API': 5.x/okhttp/okhttp3/
106
  - 'Change Logs':
107
    - 'Change Log': changelogs/changelog.md
108
    - '4.x Change Log': changelogs/changelog_4x.md
109
    - 'Upgrading to OkHttp 4': changelogs/upgrading_to_okhttp_4.md
110
    - '3.x Change Log': changelogs/changelog_3x.md
111
    - '2.x Change Log': changelogs/changelog_2x.md
112
    - '1.x Change Log': changelogs/changelog_1x.md
113
  - 'Contributing':
114
    - 'Contributing': contribute/contributing.md
115
    - 'Code of Conduct': contribute/code_of_conduct.md
116
    - 'Concurrency': contribute/concurrency.md
117
    - 'Debug Logging': contribute/debug_logging.md
118