experience-notation-docs/mkdocs.yml at main · context-notation/experience-notation-docs · 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
site_name: Experience Notation
site_url: https://experience-notation.com
repo_url: https://github.com/context-notation/experience-notation
site_description: The official documentation website for the Experience Notation, a domain-specific language (DSL) designed to model and simulate human experiences in a structured, machine-readable format.
site_author: The Cato Bot Company Limited
# site_logo: assets/images/logo.png
# site_favicon: assets/images/favicon.ico
copyright: Copyright &copy; 2025 The Cato Bot Company Limited.


theme:
  name: material
  font:
    text: Inter
    code: JetBrains Mono
  # logo: assets/images/expn-logo.svg
  # favicon: assets/images/favicon.ico
  features:
    - header.autohide
    # - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.indexes
    - navigation.sections
    # - navigation.expand
    - navigation.path
    # - navigation.top
    - content.code.annotate
    - search.suggest
    - search.highlight
    # - search.share
    - navigation.footer
    - content.code.copy
    # - content.code.select
    - content.tabs.link

  palette:
    - scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - footnotes
  - tables
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
      linenums: false
      anchor_linenums: false
      # 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.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.magiclink
  # - pymdownx.inlinehilite


# extra_css:
  # - stylesheets/custom.css

# plugins:
#   - search
extra:
  generator: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/context-notation/experience-notation-docs
      name: Experience Notation on Github
    # - icon: fontawesome/brands/x-twitter
      # link: https://twitter.com/your-twitter-handle
    # - icon: fontawesome/brands/linkedin
      # link: https://www.linkedin.com/in/your-linkedin-profile

nav:
  - Home: index.md

  - Getting Started:
      - What is Experience Notation?: getting-started/what-is-expn.md
      - Core Concepts: getting-started/core-concepts.md
      - Quick Example: getting-started/example.md

  - Specification:
    - Language Overview: spec/language-overview.md
    - EBNF Grammar: spec/ebnf.md
    - JSON Schema Reference: spec/json-schema.md
    - Validation Guide: spec/validation.md

  - AI & LLM Integration:
    - Generating Journeys with LLMs: ai/structured-prompting.md
    - Roleplaying Personas: ai/roleplay.md
    - Narrative Generation: ai/narrative-generation.md

  - Tutorials:
    - Syntax Primer: tutorials/syntax-primer.md
    - Beginner Scenarios: tutorials/beginner.md
    - Intermediate Modelling: tutorials/intermediate.md
    - Advanced Personas: tutorials/advanced-personas.md
    - Conditional Logic & Branching: tutorials/conditional.md
    - Assessment: tutorials/final-assessment.md

  - Examples:
    - Overview: examples/index.md
    - Simple Onboarding: examples/onboarding-flow.md
    - User Decision Flow: examples/decision-flow.md
    - Advanced Personas: examples/persona-showcase.md
    - External Personas: examples/external-personas.md
    - Contextual Factors: examples/context.md
    - Modular Journeys: examples/modular.md
    - Comprehensive CX Journey: examples/full-journey.md

  - Reference:
    - Glossary: reference/glossary.md
    - Citation: reference/citation.md

  - Contributing: contributing.md