api/mkdocs.yml at main · BHoM/api · 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
site_name: BHoM Object Model Documentation
copyright: Copyright &copy; 2018 - 2024 BHoM
site_url: https://bhom.xyz/api/
repo_url: https://github.com/BHoM/api
edit_uri: edit/main/docs/

theme:
  name: material
  logo: _logos/logo.png
  favicon: _logos/favicon.ico
  custom_dir: docs/overrides
  palette:
    primary: white
    accent: pink
  icon:
    edit: material/pencil
    view: material/eye

  features:
    - navigation.tracking
    - navigation.top
    - navigation.tabs
    - content.action.edit
    - content.action.view
    - content.tabs.link # allows to link to specific Content tab. See https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs
    - content.code.select # allows specific lines of code to be selected in code blocks. See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button
    - content.code.copy # allows code blocks to be copied. See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button

plugins:
  - search
  - awesome-pages # allows to customise the ordering of pages.
  - git-revision-date-localized: # Displays date created/modified on the page. The below configurations are bugged, so only date modified works.
     enable_creation_date: true
     fallback_to_build_date: true
  - redirects:
      redirect_maps:
        'index.md': 'oM/index.md'

markdown_extensions:
  - attr_list # allows to add HTML/CSS attributes to almost every Markdown element, useful for e.g. aligning an image to the left/right (can't do centre though! use md_in_html instead)
  - md_in_html # allows to add markdown within HTML elements, useful for e.g. adding image captions or centering an image

  - pymdownx.betterem # Wider support to markdown symbols

  # Code syntax highlighting
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
  - pymdownx.tabbed: # enables Content tabs.
      alternate_style: true
  - pymdownx.superfences # allows to add markdown to Content tabs. See https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#embedded-content

  # Call-outs and note boxes ('admonition')
  - admonition
  - pymdownx.details
  - pymdownx.superfences

  - toc:
      permalink: true

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js

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

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/BHoM
      name: BHoM on Github