docs/mkdocs.yml at main · abs-tudelft/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
site_name: ABS Projects and Documentation
site_url: https://abs-tudelft.github.io/docs
theme:
  name: material
  logo: assets/abs-logo.png
  favicon: assets/abs-logo.png
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.footer

nav:
  - Home: index.md
  - Chisel debug tools:
    - Tywaves:
      - Tywaves project: debugtools/tywaves.md
      - Chiselwatt use case: debugtools/tywaves-chiselwatt-usecase.md
    - ChiselTrace: debugtools/chiseltrace.md
  - Getting started with Tydi:
    - What is Tydi?: tydi/what-is-tydi.md
    - Playground: tydi/playground.md
    - Writing interfaces: tydi/interface-code.md
    - Integrations:
      - Chisel: tydi/integrations/tydi-chisel.md
      - HLS: tydi/integrations/hls.md
      - VHDL: tydi/integrations/vhdl.md
      - Clash: tydi/integrations/tydi-clash.md
    - Technical specification (Tydispec):
      - Intro: tydispec/intro.md
      - Notation: tydispec/notation.md
      - Physical streams: tydispec/physical.md
      - Logical streams: tydispec/logical.md
  # - MkDocs: mkdocs.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/abs-tudelft/
      name: ABS GitHub

plugins:
    - search
    - macros

markdown_extensions:
  # Arithmetic
  - pymdownx.arithmatex:
      generic: true
  # Source code highlighting
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  # Tabs
  - pymdownx.tabbed:
      alternate_style: true
  # Nice checkbox lists
  - pymdownx.tasklist:
      custom_checkbox: true
  # Buttons
  - attr_list
  # Notes
  - admonition
  - pymdownx.details
  # Other
  - footnotes
  - md_in_html

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
  - stylesheets/styles.css