react-waves-effect/mkdocs.yml at main · LeulAria/react-waves-effect · 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
site_name: react-waves-effect
site_url: https://leularia.github.io/react-waves-effect/
site_author: LeulAria
site_description: >-
  react-waves-effect is a react hooks for interacting with fireabase eaily.
repo_name: LeulAria/react-waves-effect
repo_url: https://github.com/LeulAria/react-waves-effect
edit_uri: ""

copyright: Copyright &copy; 2021 react-waves-effect LeulAria

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.sections
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - search.suggest
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  palette:
    - scheme: default
      primary: purple
      accent: yellow
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - scheme: slate
      primary: purple
      accent: indigo
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

extra_css:
  - "css/custom.css"
  - "css/termynal.css"

extra_javascript:
  - "https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js"
  - "js/termynal.js"
  - "js/custom.js"

plugins:
  - search
  # - macros

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  # - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.highlight:
      linenums: true
  - pymdownx.highlight:
      linenums_style: pymdownx.inline
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true

nav:
  - Home: "index.md"
  - Playground: "playground/index.md"
  - Doc: ""
  - Api: ""
  - About: ""
  - Release Notes: ""