mojo_gol/mkdocs.yml at main · EstRodr/mojo_gol · 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
site_name: Mojo Game of Life
docs_dir: docs/docs
site_dir: site

# Theme
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - search.share
    - toc.follow
    - content.code.annotate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue gray
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to light mode

# Repository
repo_name: mojo-gol
repo_url: https://github.com/EstRodr/mojo_gol
edit_uri: edit/main/docs/

# Copyright
copyright: "Copyright &copy; 2025 Your Name"

# Extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.smartsymbols
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - footnotes
  - attr_list
  - md_in_html
  - toc:
      permalink: true

# Navigation
nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
  - User Guide:
    - Basic Usage: guide/usage.md
    - Configuration: guide/configuration.md
    - Performance: guide/performance.md
  - API Reference:
    - Life: api/life.md
    - Grid: api/grid.md
  - Development:
    - Contributing: development/contributing.md
  - About:
    - Contributors: about/contributors.md
  - FAQ: faq.md
  - Architecture: architecture.md

# Plugins
plugins:
  - search
  - git-revision-date-localized
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true

# Extra
extra:
  analytics:
    provider: google
    property: YOUR-GA-PROPERTY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/yourusername/mojo-game-of-life
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/yourusername

# Build
strict: true
use_directory_urls: true