TUI-pyratatui/mkdocs.yml at main · McBorisson/TUI-pyratatui · 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
121
site_name: pyratatui
site_description: Python bindings for ratatui 0.30 — Chart, PieChart, Menu, Throbber, Checkbox, BarGraph, Tree, Markdown, Logger, Image widgets, tachyonfx effects, typed API
site_url: https://pyratatui.github.io/pyratatui
repo_url: https://github.com/pyratatui/pyratatui
repo_name: pyratatui/pyratatui
docs_dir: docs

theme:
  name: material
  palette:
    - scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.instant
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tooltips
  icon:
    repo: fontawesome/brands/github

plugins:
  - search:
      separator: '[\s\-\.]+'
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            show_signature_annotations: true
            separate_signature: true

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
  - attr_list
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Installation: installation.md
  - Tutorials:
      - Quickstart: tutorial/quickstart.md
      - Async Updates: tutorial/async_updates.md
      - Progress Bar: tutorial/progress_bar.md
      - Tables & Lists: tutorial/table_updates.md
      - TachyonFX Effects: tutorial/tachyonfx_effects.md
  - API Reference:
      - Terminal & Frame: reference/terminal.md
      - Layout: reference/layout.md
      - Widgets: reference/widgets.md
      - Style & Text: reference/style.md
      - Effects (TachyonFX): reference/effects.md
      - Prompts: reference/prompts.md
      - Popups: reference/popups.md
      - TextArea: reference/textarea.md
      - ScrollView: reference/scrollview.md
      - QrCodeWidget: reference/qrcode.md
      - Calendar: reference/calendar.md
      - BarGraph: reference/bar_graph.md
      - TreeWidget: reference/tree_widget.md
      - Markdown: reference/markdown.md
      - Logger: reference/logger.md
      - ImageWidget: reference/image_widget.md
      - Throbber: reference/throbber_widget.md
      - Menu: reference/menu_widget.md
      - PieChart: reference/piechart_widget.md
      - Checkbox: reference/checkbox_widget.md
      - Chart: reference/chart_widget.md
      - Buffer: reference/buffer.md
  - Examples:
      - Minimal Examples: examples/minimal_examples.md
      - Advanced Examples: examples/advanced_examples.md
  - Build & Package:
      - Build Scripts: build/build_scripts.md
      - Packaging: build/packaging.md
  - FAQ: faq.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pyratatui/pyratatui
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pyratatui

copyright: "pyratatui contributors — MIT License"