DrawBox/mkdocs.yml at main · akshay2211/DrawBox · 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
site_name: DrawBox - Kotlin Multiplatform Drawing SDK
site_description: DrawBox is an open-source Kotlin Multiplatform drawing SDK for Compose Multiplatform. Embed editable drawing, annotation, diagramming, and export capabilities across Android, iOS, Desktop, and Web.
site_url: https://akshay2211.github.io/DrawBox/
repo_url: https://github.com/akshay2211/DrawBox
repo_name: DrawBox
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: site

# Copy additional files to build output
copy_files:
  - robots.txt

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.tabs.link

plugins:
  - search:
      lang: en
  - minify:
      minify_html: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/akshay2211/DrawBox
  generator: true

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - attr_list
  - md_in_html
  - admonition

nav:
  - Home: index.md
  - Try it Live: /DrawBox/sample/
  - Getting Started:
    - Overview: getting-started/overview.md
    - Installation: getting-started/installation.md
    - Quick Start Guide: getting-started/quickstart.md
    - System Requirements: getting-started/requirements.md
    - Use Cases: guides/use-cases.md
  - Features:
    - Drawing Modes: features/drawing-modes.md
    - Drawing Tools: features/tools.md
    - Colors & Stroke Styles: features/colors-styles.md
    - Undo & Redo: features/undo-redo.md
    - Export & Save: features/export-save.md
  - User Guide:
    - Basic Drawing: user-guide/basic-drawing.md
    - Advanced Techniques: user-guide/advanced-techniques.md
    - Keyboard Shortcuts: user-guide/shortcuts.md
  - Guides:
    - Use Cases & Applications: guides/use-cases.md
    - Comparison with Alternatives: guides/comparison.md
  - Development:
    - Architecture: development/architecture.md
    - Project Structure: development/project-structure.md
    - Building from Source: development/build-from-source.md
    - Contributing Guide: development/contributing.md
  - Technical:
    - Kotlin Multiplatform: technical/kotlin-multiplatform.md
    - Compose Architecture: technical/compose-architecture.md
    - API Reference: technical/api-reference.md
    - Performance: technical/performance.md
  - Dokka API Docs: https://akshay2211.github.io/DrawBox/dokka/
  - FAQ: faq.md
  - License: license.md