DataModelTemplate/mkdocs_template.yml at main · ivoa/DataModelTemplate · 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
site_name: Model Documentation
docs_dir: doc/site
repo_url: 'https://github.com/ivoa/DataModelTemplate'

theme:
  name: material
  features:
    - navigation.tabs
    - content.action.edit
    - content.tooltips
markdown_extensions:
  - tables
  - footnotes
  - attr_list
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - plantuml_markdown:
      #note that base_dir has to be specified for plantuml as it does not pick it up from mkdocs config
      base_dir: doc/site
      format: svg
      remove_inline_svg_size: false
      cachedir: build/generated/plantuml
nav:
  - Introduction: index.md
  - Schema: schema.md
  - AutoGenerated Documentation:
  - JavaDoc: generated/javadoc