rustico/mkdocs.yml at main · simwai/rustico · 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
site_name: rustico
site_description: A Schrödinger's Cat for Python error handling - your result is both alive and dead—until you unwrap it.
site_author: Simon Waiblinger
site_url: https://github.com/simwai/rustico

repo_name: simwai/rustico
repo_url: https://github.com/simwai/rustico
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  palette:
    # Discord-inspired dark theme (primary)
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    # Light mode alternative
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.highlight
    - search.share

nav:
  - Home: index.md
  - Quick Start: quickstart.md
  - Examples: examples.md
  - Comparison: comparison.md
  - Contributing: contributing.md
  - API Reference:
      - ...

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format ""
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji ""
      emoji_generator: !!python/name:material.extensions.emoji.to_svg ""
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - attr_list
  - md_in_html
  - def_list

plugins:
  - search
  - awesome-pages:
      collapse_single_pages: true
      strict: false
      order: asc
      sort_type: natural
      order_by: title
extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/simwai/rustico
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/rustico/
  # Discord-inspired status indicators
  status:
    new: ✨ New
    deprecated: ⚠️ Deprecated