scratch-api.github.io/mkdocs.yml at main · scratch-api/scratch-api.github.io · 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
120
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: Scratch (API) Documentation
site_url: https://scratchapi.org/
site_description: Documentation for the Scratch API and other things

repo_url: https://github.com/scratch-api/scratch-api.github.io
repo_name: scratch-api/scratch-api.github.io
edit_uri: 'edit/main/docs/'

theme:
  name: material
  custom_dir: overrides

  logo: assets/logo.png
  favicon: assets/logo.png

  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: orange
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: orange
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - content.action.edit
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.instant.preview
    - navigation.tracking
    - navigation.tabs
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - content.code.annotate

plugins:
  - social
  - search
  - glightbox
  - meta
  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: "docs.hooks:on_pre_build"
        on_post_build: "docs.hooks:on_post_build"

#  - macros
#  - include-markdown

markdown_extensions:
  - md_in_html
  - admonition
  - pymdownx.details
  - attr_list
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - footnotes
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - attr_list
  - pymdownx.blocks.caption
  - pymdownx.extra
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
extra:
  social:
    # Took this from the goboscript mkdocs yml file
    - icon: fontawesome/brands/github
      link: https://github.com/scratch-api/
    - icon: fontawesome/brands/discord
      link: https://discord.gg/mgxyyfnfk8

  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/scratch-api/scratch-api.github.io/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form</a>.