TIDES/mkdocs.yml at main · carlfredl/TIDES · 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
site_name: "Transit Integrated Data Exchange Specification (TIDES) Suite"
site_url: https://TIDES-transit.github.io/TIDES
repo_url: https://github.com/TIDES-transit/TIDES
edit_uri: edit/main/docs

theme:
  name: material
  logo: assets/bus-surf.svg
  favicon: assets/tides.ico
  features:
    - content.code.copy
    - navigation.tabs
    - navigation.expand
    - toc.integrate
    - toc.follow
  palette:
      primary: custom
      accent: custom
      text: custom
      background: custom
      highlight: custom

plugins:
  - autorefs
  - awesome-pages
  - include-markdown
  - macros
  - mermaid2:
      arguments:
        theme: |
            ^(window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'
        securityLevel: 'loose'
  - mike:
      version_selector: true
  - search

extra:
  version:
    provider: mike

watch:
  - CONTRIBUTING.md
  - contributors.md
  - README.md

extra_javascript:
  - https://unpkg.com/mermaid@9.4.3/dist/mermaid.min.js

extra_css:
  - https://use.fontawesome.com/releases/v5.13.0/css/all.css
  - stylesheets/tides.css

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.details
  - codehilite:
      linenums: true
  - meta
  - pymdownx.inlinehilite
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.smartsymbols
  - smarty
  - toc:
      # insert a blank space before the character
      permalink: " ¶"
      toc_depth: 3

nav:
  - Home: index.md
  - Specification:
      - Architecture: architecture.md
      - Table Schemas: tables.md
      - Data Package: datapackage.md
  - Sample Data: samples.md
  - Contributing:
      - Development: development.md
      - Documentation: documentation.md
  - Governance:
      - Governance Structure: governance.md
      - Change Management: governance/policies/change-management.md
      - Other Policies:
          - Code of conduct: governance/policies/code-of-conduct.md
          - Contributor license agreement: governance/policies/CLA.md
      - Board Actions: governance/actions.md
      - Board Meetings: governance/meetings.md
  - Awesome: awesome.md

copyright: |
    <footer>
        <div class="container">
            <div class="row">
                <div class="col-md-12">
                    <p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/TIDES-transit/TIDES/">TIDES Project</a> by <span property="cc:attributionName">TIDES Board of Directors</span> is licensed under <a href="http://creativecommons.org/licenses/by/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1"></a></p>
                </div>
            </div>
        </div>
    </footer>