Jetpack-Android-Starter/mkdocs.yml at main · atick-faisal/Jetpack-Android-Starter · 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
site_name: Jetpack Android Starter
repo_name: Jetpack-Android-Starter
repo_url: https://github.com/atick-faisal/Jetpack-Android-Starter

theme:
  name: material
  icon:
    logo: octicons/rocket-24
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: white
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-sunny
        name: Switch to system preference

  features:
    - navigation.indexes
    - navigation.top
    - content.action.view
    - content.code.copy

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - admonition

nav:
  - Getting Started: getting-started.md
  - Core Concepts:
      - Architecture: architecture.md
      - Philosophy: philosophy.md
      - State Management: state-management.md
  - Development Guide:
      - Adding Features: guide.md
      - Components: components.md
      - Data Flow: data-flow.md
      - Navigation: navigation.md
      - Dependency Injection: dependency-injection.md
      - Dependencies: dependency.md
      - Quick Reference: quick-reference.md
  - Tools & Configuration:
      - Spotless: spotless.md
      - Fastlane: fastlane.md
      - Firebase: firebase.md
      - GitHub: github.md
      - Plugins: plugins.md
  - Best Practices:
      - Performance: performance.md
      - Tips: tips.md
  - Troubleshooting:
      - Common Issues: troubleshooting.md
      - FAQ: faq.md
  - 📚 API Reference: api/index.html
  - ⚖️ License: license.md

extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:atickfaisal@gmail.com
    - icon: fontawesome/brands/github
      link: https://github.com/atick-faisal
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/atick-faisal
    - icon: fontawesome/brands/medium
      link: https://atickfaisal.medium.com
    - icon: fontawesome/brands/stack-overflow
      link: https://stackoverflow.com/users/12737399/atick-faisal
    - icon: fontawesome/brands/researchgate
      link: https://scholar.google.com/citations?user=ZiPKjAgAAAAJ&hl=en

plugins:
  - gh-admonitions
  - search
  - tags

copyright: Copyright &copy; 2025 Atick Faisal