kotlin-toolkit/mkdocs.yml at develop · stevenzeck/kotlin-toolkit · 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
site_name: Readium Kotlin

# Meta tags (placed in header)
site_description: Readium Mobile is a toolkit for ebooks, audiobooks and comics written in Swift & Kotlin.
site_author: Readium Foundation
site_url: https://github.com/readium/kotlin-toolkit

# Repository (add link to repository on each page)
repo_name: kotlin-toolkit
repo_url: https://github.com/readium/kotlin-toolkit

# Copyright (shown at the footer)
copyright: 'Copyright &copy; 2026 Readium Foundation'

# Material theme
theme:
  name: 'material'
  #  favicon: favicon.svg
  social:
    - type: 'github'
      link: 'https://github.com/readium/kotlin-toolkit'
  features:
    - navigation.tabs
    - navigation.path

# Extensions
markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - footnotes
  - meta
  - def_list
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.smartsymbols
  - pymdownx.superfences

hooks:
  - docs/scripts/hooks.py

exclude_docs: |
  scripts/

validation:
  links:
    unrecognized_links: warn
    absolute_links: warn

# Dev server binding
#dev_addr: 127.0.0.1:3001

nav:
  - Home: index.md
  - Migration Guide: migration-guide.md
  - API Reference: api/index.html
  - User Guides:
      - Getting started: guides/getting-started.md
      - Extracting the content of a publication: guides/content.md
      - Opening a publication: guides/open-publication.md
      - Navigator: guides/navigator/navigator.md
      - Media navigator: guides/navigator/media-navigator.md
      - Navigator preferences: guides/navigator/preferences.md
      - EPUB font families: guides/navigator/epub-fonts.md
      - PDF support: guides/pdf.md
      - Text-to-speech: guides/tts.md
      - Accessibility: guides/accessibility.md
      - LCP: guide/lcp.md

extra_css:
  - readium_colors.css

extra:
  version:
    provider: mike