toss-share/mkdocs.yml at main · rennerdo30/toss-share · 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
122
123
124
125
126
127
128
129
130
131
132
133
site_name: Toss Documentation
site_description: Cross-platform clipboard sharing with end-to-end encryption
site_author: Toss Contributors
site_url: https://rennerdo30.github.io/toss-share/

repo_name: rennerdo30/toss-share
repo_url: https://github.com/rennerdo30/toss-share
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  language: en

  # Color palette with toggle (dark mode default, matching renner.dev)
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

  # Font configuration
  font:
    text: Inter
    code: Fira Code

  # Features
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - header.autohide

  # Icons
  icon:
    logo: material/rocket-launch
    repo: fontawesome/brands/github

  # Favicon
  favicon: assets/images/favicon.png

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: 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.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: getting-started/quick-start.md
    - Installation: getting-started/installation.md
    - Development Setup: getting-started/development-setup.md
  - User Guide:
    - Overview: user-guide/overview.md
    - Pairing Devices: user-guide/pairing.md
    - Using Toss: user-guide/using-toss.md
  - Developer Guide:
    - Architecture: developer-guide/architecture.md
    - API Reference: developer-guide/api-reference.md
    - Platform Support: developer-guide/platform-support.md
    - Testing: developer-guide/testing.md
  - Platform-Specific:
    - Overview: platform-specific/overview.md
    - macOS: platform-specific/macos.md
    - Windows: platform-specific/windows.md
    - Linux: platform-specific/linux.md
    - iOS: platform-specific/ios.md
    - Android: platform-specific/android.md
    - iOS & Android Guide: platform-specific/ios-android.md
  - Contributing:
    - Contributing Guide: contributing/contributing.md
    - Code of Conduct: contributing/code-of-conduct.md
    - Security Policy: contributing/security.md
  - Project Status:
    - Current Status: project-status/status.md
    - Implementation Summary: project-status/implementation-summary.md
    - TODO List: project-status/todo.md
    - Changelog: project-status/changelog.md
  - Future Enhancements: future-enhancements.md
  - Specification: specification.md

extra_css:
  - assets/stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rennerdo30/toss-share
  version:
    provider: mike

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true