async-storage/mkdocs.yml at main · react-native-async-storage/async-storage · GitHub

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
site_name: Async Storage
repo_url: https://github.com/react-native-async-storage/async-storage
site_url: https://react-native-async-storage.github.io/

# note: index, contributing and changelog are symlinked
nav:
  - Overview: index.md
  - API:
      - Usage: api/usage.md
      - "Database naming": api/db-naming.md
      - "Error handling": api/errors.md
      - "Brownfield integration": api/brownfield.md
  - Integrations:
      - Expo: integrations/expo.md
      - Jest: integrations/jest.md
      - Brownfield: integrations/brownfield.md
  - "Migration to v3": migration-to-3.md
  - FAQ: faq.md
  - Contributing: contributing.md
  - Changelog: changelog.md

theme:
  name: material
  palette:
    primary: custom
    accent: custom
  logo: assets/logo.png
  favicon: assets/logo.png
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
  custom_dir: docs/overrides

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      name: Async Storage
      link: https://github.com/react-native-async-storage/async-storage
  version:
    provider: mike
    alias: true