fast-rich 0.3.1

A Rust port of Python's Rich library for beautiful terminal formatting
Documentation 
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

site_name: Fast-Rich
site_description: High-performance Rust port of Python's Rich library for beautiful terminal formatting
site_url: https://mohammad-albarham.github.io/fast-rich
repo_url: https://github.com/mohammad-albarham/fast-rich
repo_name: mohammad-albarham/fast-rich
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - toc.follow

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Guides:
    - guides/index.md
    - Text & Styles: guides/text-styles.md
    - Console: guides/console.md
    - Tables: guides/tables.md
    - Panels & Rules: guides/panels.md
    - Progress Bars: guides/progress.md
    - Live Display: guides/live.md
    - Tree Views: guides/tree.md
    - Layouts: guides/layout.md
    - Syntax Highlighting: guides/syntax.md
    - Markdown: guides/markdown.md
    - Logging: guides/logging.md
    - Tracebacks: guides/traceback.md
  - Examples: rust_examples.md
  - Tutorials:
    - Dashboard: tutorial_dashboard.md
  - Reference:
    - API Overview: reference/api.md
    - Benchmarks: benchmarks.md
  - Python Bindings:
    - Installation: python_install.md
    - API Reference: python_api.md
  - Contributing:
    - contributing/index.md
    - Building Docs: contributing/building-docs.md
    - Changelog: CHANGELOG.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.mark
  - pymdownx.keys
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - tables
  - toc:
      permalink: true
      toc_depth: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mohammad-albarham/fast-rich
    - icon: fontawesome/brands/rust
      link: https://crates.io/crates/fast-rich
  generator: false

copyright: Copyright © 2024 Mohammad Albarham