Frahan/mkdocs.yml at main · libishm1/Frahan · 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
# Frahan StonePack documentation site (GitHub Pages).
# Built by .github/workflows/pages.yml: the workflow assembles _site_src/ from
# the repo's markdown + images (structure preserved so relative links keep
# working), then runs `mkdocs build`. Locally: run the same copy steps from the
# workflow, then `pip install mkdocs-material && mkdocs serve`.
site_name: Frahan StonePack
site_description: >-
  Stone-fabrication readiness for Rhino/Grasshopper - scan and GPR ingestion,
  fracture modelling, 2D/3D nesting, masonry stability, and pre-CAM cut planning.
site_url: https://libishm1.github.io/Frahan/
repo_url: https://github.com/libishm1/Frahan
repo_name: libishm1/Frahan
docs_dir: _site_src

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      toggle:
        icon: material/brightness-4
        name: Light mode
  features:
    - navigation.sections
    - navigation.top
    - search.suggest
    - content.code.copy

markdown_extensions:
  - tables
  - admonition
  - fenced_code
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Nest (live demo): https://libishm1.github.io/Frahan/nest/
  - Install: docs/INSTALL.md
  - Component Reference: docs/components/COMPONENTS.md
  - Results & Benchmarks: docs/results/RESULTS.md
  - Examples: examples/README.md
  - Mathematics:
      - Overview & verification ladder: wiki/research/math/INDEX.md
      - Packing (2D + 3D): wiki/research/packing/EQUATIONS.md
      - Masonry & Stability: wiki/research/math/MASONRY_STABILITY.md
      - Edge Matching & Surfaces: wiki/research/math/EDGE_MATCHING_SURFACE.md
      - Geology, GPR & Cutting: wiki/research/math/GEOLOGY_GPR_CUTTING.md
      - Lean Formalization Plan: wiki/research/math/LEAN_PLAN.md
      - Coverage Audit (249 algorithms): wiki/research/math/AUDIT_coverage.md
  - Research wiki:
      - Index: wiki/index.md
      - Risk Register: wiki/research/RISK_REGISTER.md
      - Engineering log: wiki/log.md
      - Edge Matching (theory vs implementation): wiki/research/edge_matching_theory_vs_implementation.md
      - Tolerances & Dimensions: wiki/research/tolerances_dimensions_slm_roses.md
      - 2D Packing Synthesis: wiki/research/packing/SYNTHESIS_2D.md
      - 3D Packing Synthesis: wiki/research/packing/SYNTHESIS_3D.md
  - More:
      - Thesis: docs/STONEPACK_THESIS.md
      - Supersession Map: docs/SUPERSESSION_MAP.md
      - Persona Map: docs/PERSONA_MAP.md
      - Reviewer Summary: docs/REVIEWER_SUMMARY.md
      - Contributing: CONTRIBUTING.md
      - Contributors: CONTRIBUTORS.md
      - Release Notes: RELEASE_NOTES_v0.1.0-alpha.md