emn/mkdocs.yml at develop · holixon/emn · 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
# ###############################
# Main config file for MkDocs.
# ###############################
#
# To run:
# mkdocs serve
# ###############################

site_name: Event Modeling Notation
site_url: https://holixon/emn/
site_author: Holisticon AG
site_description: >-
  Event Modeling Notation (EMN) is an XML-based language for modeling system behavior through events,
  commands, and user interactions. It captures event-driven flows in a structured, time-ordered format called a Timeline.
  EMN introduces concepts like Slices and Lanes to represent system responsibilities and interactions.
  Diagrams are represented using the OMG Diagram Interchange (DI) standard for tool interoperability.
  The goal of EMN is to provide a formal, machine-readable format for event modeling, enabling clear
  communication between technical and business teams.
copyright: Copyright &copy; 2024 - 2025, EMN Working Group

use_directory_urls: false

# Repository
repo_name: holixon/emn
repo_url: https://github.com/holixon/emn/
edit_uri: edit/develop/docs/

markdown_extensions:
  - attr_list
  - toc:
      permalink: "#"
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - admonition
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

theme:
  name: material
  features:
    - navigation.instant # When instant loading is enabled, clicks on all internal links will be intercepted and dispatched via XHR without fully reloading the page
    - navigation.tabs # add top level nav items into a horizoneal menu
    - navigation.tabs.sticky # make horizontal menu sticky (insider feature)
    - navigation.sections
    - navigation.top # add "navigate to top" page icon on bottom left
    - toc.integrate # integrate site TOC into the menu on the left
  logo: assets/img/emn-logo-light.svg
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  custom_dir: overrides

extra_css:
  - stylesheets/extra.css
  - stylesheets/adr.css

extra:
  social:
  #    - icon: fontawesome/brands/twitter
  #      name: Holisticon on Twitter
  #      link: https://twitter.com/holisticon
  version:
    provider: mike

hooks:
  - hooks/adrs.py

plugins:
  - search
  - awesome-nav # must be before macros
  - mike:
      version_selector: true          # set to false, in order to leave out the version selector
      css_dir: css                    # the directory to put the version selector's CSS
      javascript_dir: js              # the directory to put the version selector's JS
      canonical_version: null         # the version for <link rel="canonical">; `null`
      # uses the version specified via `mike deploy`
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true