mirror of
https://github.com/square/okhttp.git
synced 2026-01-14 07:22:20 +03:00
106c8d2d5c
* Improve OkHttp documentation * Remove placeholder files * remove site folder * Create upgrading_to_okhttp_4.md * Add redirects and fix paths * add missing tls page to redirects * Use custom SVG icons * Update deploy_website.sh * Push new changes.
134 lines
4.8 KiB
YAML
134 lines
4.8 KiB
YAML
site_name: OkHttp
|
|
site_url: https://square.github.io/okhttp/
|
|
repo_name: OkHttp
|
|
repo_url: https://github.com/square/okhttp
|
|
site_description: "An HTTP & HTTP/2 client for Android and Java applications"
|
|
site_author: Square, Inc.
|
|
remote_branch: gh-pages
|
|
edit_uri: ""
|
|
|
|
copyright: 'Copyright © 2019-2022 Square, Inc.'
|
|
|
|
theme:
|
|
name: 'material'
|
|
favicon: assets/images/icon-square.png
|
|
logo: assets/images/icon-square.png
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: teal
|
|
accent: blue
|
|
toggle:
|
|
icon: octicons/sun-24
|
|
name: "Switch to Dark Mode"
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: teal
|
|
accent: blue
|
|
toggle:
|
|
icon: octicons/moon-24
|
|
name: "Switch to Light Mode"
|
|
features:
|
|
- navigation.tabs
|
|
|
|
extra_css:
|
|
- 'assets/css/app.css'
|
|
|
|
markdown_extensions:
|
|
- smarty
|
|
- footnotes
|
|
- meta
|
|
- toc:
|
|
permalink: true
|
|
- attr_list
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.magiclink
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.superfences
|
|
- pymdownx.tilde
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
|
|
plugins:
|
|
- redirects:
|
|
redirect_maps:
|
|
# Redirect all feature pages to features/*
|
|
'caching.md': 'features/caching.md'
|
|
'calls.md': 'features/calls.md'
|
|
'concurrency.md': 'features/concurrency.md'
|
|
'connections.md': 'features/connections.md'
|
|
'debug_logging.md': 'features/debug_logging.md'
|
|
'events.md': 'features/events.md'
|
|
'https.md': 'features/events.md'
|
|
'interceptors.md': 'features/interceptors.md'
|
|
'r8_proguard.md': 'features/r8_proguard.md'
|
|
# Redirect all Security pages to security/*
|
|
'security.md': 'security/security.md'
|
|
'security_providers.md': 'security/security_providers.md'
|
|
# Redirect upgrading_to_okhttp_4 to 4.x/*
|
|
'upgrading_to_okhttp_4.md': '4.x/upgrading_to_okhttp_4.md'
|
|
# Redirect all changelog pages to changelog/*
|
|
'changelog.md': 'changelogs/changelog.md'
|
|
'changelog_3x.md': 'changelogs/changelog_3x.md'
|
|
'changelog_2x.md': 'changelogs/changelog_2x.md'
|
|
'changelog_1x.md': 'changelogs/changelog_1x.md'
|
|
'tls_configuration_history.md': 'changelogs/tls_configuration_history.md'
|
|
# Redirect all contributing pages to contribute/*
|
|
'contributing.md': 'contribute/contributing.md'
|
|
'code_of_conduct.md': 'contribute/code_of_conduct.md'
|
|
|
|
nav:
|
|
- 'Overview':
|
|
- 'Introduction': index.md
|
|
- 'Stack Overflow': https://stackoverflow.com/questions/tagged/okhttp?sort=active
|
|
- 'Features':
|
|
- 'Caching': features/caching.md
|
|
- 'Calls': features/calls.md
|
|
- 'Concurrency': features/concurrency.md
|
|
- 'Connections': features/connections.md
|
|
- 'Debug Logging': features/debug_logging.md
|
|
- 'Events': features/events.md
|
|
- 'HTTPS': features/https.md
|
|
- 'Interceptors': features/interceptors.md
|
|
- 'R8 / ProGuard': features/r8_proguard.md
|
|
- 'Recipes': recipes.md
|
|
- 'Security':
|
|
- 'Security Policy': security/security.md
|
|
- 'Security Providers': security/security_providers.md
|
|
- 'Works with OkHttp': works_with_okhttp.md
|
|
- '4.x API':
|
|
- 'Upgrading to OkHttp 4': 4.x/upgrading_to_okhttp_4.md
|
|
- 'okhttp': 4.x/okhttp/okhttp3/index.md
|
|
- 'brotli': 4.x/okhttp-brotli/okhttp3.brotli/index.md
|
|
- 'dnsoverhttps': 4.x/okhttp-dnsoverhttps/okhttp3.dnsoverhttps/index.md
|
|
- 'logging-interceptor': 4.x/okhttp-logging-interceptor/okhttp3.logging/index.md
|
|
- 'sse': 4.x/okhttp-sse/okhttp3.sse/index.md
|
|
- 'tls': 4.x/okhttp-tls/okhttp3.tls/index.md
|
|
- 'urlconnection': 4.x/okhttp-urlconnection/okhttp3/index.md
|
|
- 'mockwebserver': 4.x/mockwebserver/okhttp3.mockwebserver/index.md
|
|
- '3.12.x API':
|
|
- 'okhttp': https://square.github.io/okhttp/3.x/okhttp/
|
|
- 'dnsoverhttps': https://square.github.io/okhttp/3.x/okhttp-dnsoverhttps/
|
|
- 'logging-interceptor': https://square.github.io/okhttp/3.x/logging-interceptor/
|
|
- 'sse': https://square.github.io/okhttp/3.x/okhttp-sse/
|
|
- 'tls': https://square.github.io/okhttp/3.x/okhttp-tls/
|
|
- 'urlconnection': https://square.github.io/okhttp/3.x/okhttp-urlconnection/
|
|
- 'mockwebserver': https://square.github.io/okhttp/3.x/mockwebserver/
|
|
- 'Change Logs':
|
|
- 'Latest': changelogs/changelog.md
|
|
- 'Version 3.x': changelogs/changelog_3x.md
|
|
- 'Version 2.x': changelogs/changelog_2x.md
|
|
- 'Version 1.x': changelogs/changelog_1x.md
|
|
- 'TLS History': changelogs/tls_configuration_history.md
|
|
- 'Contributing':
|
|
- 'Contribute': contribute/contributing.md
|
|
- 'Code of Conduct': contribute/code_of_conduct.md
|
|
|