flow-docs/mkdocs.yml at main · The-Flow-Project/flow-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
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# Project information
site_name: "Flow-Project"
site_url: https://docs.flow-project.net/
site_author: "Flow-Project Team"
site_description: "Documentation for the Flow-Project, an open-source environment for handwritten text recognition (HTR) and related tasks."
repo_name: The-Flow-Project/flow-docs
repo_url: https://github.com/The-Flow-Project/flow-docs
edit_uri: https://github.com/The-Flow-Project/flow-docs/tree/main/docs

use_directory_urls: false
extra_css:
  - stylesheets/extra.css

# Page tree
nav:
  - Flow-Project Docs: index.md
  - Packages: packages.md
  - Services: services.md
  # - Getting started :
  #  - Installation: getting_started/installation.md
  #  - Quickstart: getting_started/quick_start.md

  # - Reference:
  #  - Links to api references of the different packages

  # - Help:
  #  - FAQ: help/faq.md
  #  - Contribution: help/contributing.md


# Configuration
theme:
  name: material
  custom_dir: docs/overrides

  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - navigation.indexes
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - content.code.annotate
    - announce.dismiss
    - toc.follow

  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.ico
  logo: assets/TheFlow_white.png
  # logo: assets/TheFlow_black.png
  icon:
    repo: fontawesome/brands/github

plugins:
  - tags
  - search
  - mkdocs-jupyter:
      kernel_name: python3
      include_source: True
  - table-reader:
      data_path: "."
      allow_missing_files: False
      select_readers:
        - read_csv
        - read_json
      enabled: True
  - git-revision-date-localized
  - termynal:
      prompt_literal_start:
        - "$"
        - ">"

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/the-flow-project
      name: Github
extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - tables
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets