Python-Redlines/mkdocs.yml at main · JSv4/Python-Redlines · 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
site_name: Python-Redlines
site_url: https://jsv4.github.io/Python-Redlines/
site_description: >-
  Open-source DOCX comparison tool to generate native Word tracked changes (redlines)
  in Python without MS Word dependencies.
site_author: John Scrudato IV
repo_name: JSv4/Python-Redlines
repo_url: https://github.com/JSv4/Python-Redlines
edit_uri: edit/main/docs/
docs_dir: docs
copyright: MIT License

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - search.suggest
    - content.code.copy
    - content.action.edit

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Tutorials:
      - How to compare two Word documents in Python: tutorials/how-to-compare-word-documents-python.md
  - Alternatives: alternatives.md
  - Developer Guide: developer-guide.md

markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/JSv4/Python-Redlines
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/python-redlines/