xref: /aosp_15_r20/external/okio/mkdocs.yml (revision f9742813c14b702d71392179818a9e591da8620c)
1site_name: Okio
2site_url: https://square.github.io/okio
3repo_name: Okio
4repo_url: https://github.com/square/okio
5site_description: "A modern I/O library for Android, Kotlin, and Java."
6site_author: Square, Inc.
7remote_branch: gh-pages
8edit_uri: ""
9
10copyright: 'Copyright © 2019 Square, Inc.'
11
12theme:
13  name: 'material'
14  favicon: images/icon-square.png
15  logo: images/icon-square.png
16  palette:
17    # Palette toggle for light mode
18    - scheme: default
19      media: "(prefers-color-scheme: light)"
20      primary: 'deep purple'
21      accent: 'white'
22      toggle:
23        icon: material/brightness-7
24        name: Switch to dark mode
25    # Palette toggle for dark mode
26    - scheme: slate
27      media: "(prefers-color-scheme: dark)"
28      primary: 'deep purple'
29      accent: 'white'
30      toggle:
31        icon: material/brightness-4
32        name: Switch to light mode
33  icon:
34    repo: fontawesome/brands/github
35
36extra:
37  social:
38    - icon: fontawesome/brands/twitter
39      link: https://twitter.com/squareeng
40    - icon: fontawesome/brands/stack-overflow
41      link: https://stackoverflow.com/questions/tagged/okio?sort=active
42
43extra_css:
44  - 'css/app.css'
45
46markdown_extensions:
47  - smarty
48  - codehilite:
49      guess_lang: false
50  - footnotes
51  - meta
52  - toc:
53      permalink: true
54  - pymdownx.betterem:
55      smart_enable: all
56  - pymdownx.caret
57  - pymdownx.inlinehilite
58  - pymdownx.magiclink
59  - pymdownx.smartsymbols
60  - pymdownx.superfences
61  - pymdownx.tabbed:
62      alternate_style: true
63  - pymdownx.tilde
64  - tables
65
66nav:
67  - 'Overview': index.md
68  - 'Stack Overflow ⏏': https://stackoverflow.com/questions/tagged/okio?sort=active
69  - 'Recipes': recipes.md
70  - 'java.io Recipes': java_io_recipes.md
71  - '3.x API':
72    - 'okio': 3.x/okio/okio/okio/index.html
73    - 'fakefilesystem': 3.x/okio-fakefilesystem/okio-fakefilesystem/okio.fakefilesystem/-fake-file-system/index.html
74    - 'nodefilesystem': 3.x/okio-nodefilesystem/okio-nodefilesystem/okio/-node-js-file-system/index.html
75  - '1.x API ⏏': https://square.github.io/okio/1.x/okio/
76  - 'Change Log': changelog.md
77  - 'File System': file_system.md
78  - 'Multiplatform': multiplatform.md
79  - 'Contributing': contributing.md
80  - 'Code of Conduct': code_of_conduct.md
81