PentaTile/mkdocs.yml at main · Shilo/PentaTile · 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
site_name: PentaTile
site_description: Lightweight dual-grid autotiling addon for Godot 4.6
site_url: https://shilo.github.io/PentaTile/
repo_url: https://github.com/Shilo/PentaTile
repo_name: Shilo/PentaTile

theme:
  name: material
  language: en
  logo: assets/brand/penta_tile_icon.png
  favicon: assets/brand/penta_tile_icon.png
  palette:
    - scheme: slate
      primary: teal
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: teal
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy

hooks:
  # Regenerates docs/api-reference.md from Godot ## doc-comments before each build.
  # See tools/mkdocs_hooks.py and Phase 7 reversal at
  # .planning/phases/07-repo-restructure-extract-tests-mkdocs-site-llm-friendly-docs/07-LLM-DOCS-DECISION-REVISION.md
  - tools/mkdocs_hooks.py

plugins:
  - search
  - llmstxt:
      # Generates site/llms.txt (TOC index per llmstxt.org spec) and
      # site/llms-full.txt (full content concatenation) on every mkdocs build.
      # Requires site_url to be set (we have it at line 3).
      full_output: llms-full.txt
      markdown_description: |
        PentaTile is a lightweight dual-grid autotiling addon for Godot 4.6+.
        Users paint with the native TileMapLayer set_cell / erase_cell API;
        the addon dispatches those logic cells into visual cells through
        _update_cells. A pluggable PentaTileLayout resource defines mask
        topology and slot resolution, with native support for Penta,
        DualGrid16, Wang2Edge, Wang2Corner, Minimal3x3, Blob47Godot, and
        PixelLab top-down/side-scroller layouts.
      sections:
        Getting Started:
          - index.md: Quickstart and core concepts
          - installation.md: Install via GitHub Release zip into addons/
        Layouts:
          - layouts/index.md: Layout overview and selection guide
          - layouts/penta.md: Penta — the project's native 5-archetype format
          - layouts/dual-grid-16.md: DualGrid16 — 16-tile corner-mask atlas
          - layouts/wang-2-edge.md: Wang2Edge — 16-tile edge-mask atlas
          - layouts/wang-2-corner.md: Wang2Corner — 16-tile corner-mask atlas
          - layouts/minimal-3x3.md: Minimal3x3 — 9-tile single-grid edge-mask
          - layouts/blob-47-godot.md: Blob47Godot — BorisTheBrave 47-blob convention
          - layouts/pixellab-top-down.md: PixelLab Top-Down — 8x8 corner-mask
          - layouts/pixellab-side-scroller.md: PixelLab Side-Scroller — 8x8 corner-mask
        Reference:
          - penta-tileset.md: What is a Penta tileset? — codename definition
          - custom-layouts.md: Authoring a custom PentaTileLayout subclass
          - api-reference.md: Full GDScript API extracted from GDScript documentation comments
        About:
          - llm-docs.md: How LLMs and agents should consume these docs

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: true

nav:
  - Quickstart: index.md
  - Installation: installation.md
  - Layouts:
      - Overview: layouts/index.md
      - Penta: layouts/penta.md
      - DualGrid 16: layouts/dual-grid-16.md
      - Wang 2-Edge: layouts/wang-2-edge.md
      - Wang 2-Corner: layouts/wang-2-corner.md
      - Minimal 3x3: layouts/minimal-3x3.md
      - Blob 47 Godot: layouts/blob-47-godot.md
      - PixelLab Top-Down: layouts/pixellab-top-down.md
      - PixelLab Side-Scroller: layouts/pixellab-side-scroller.md
  - What is a Penta tileset?: penta-tileset.md
  - Authoring Custom Layouts: custom-layouts.md
  - API Reference: api-reference.md
  - LLM Docs: llm-docs.md