kiosque/mkdocs.yml at master · xoolive/kiosque · 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
site_name: Kiosque
site_description: News article extraction and bookmark management tool
site_author: Xavier Olive
site_url: https://xoolive.github.io/kiosque

repo_name: xoolive/kiosque
repo_url: https://github.com/xoolive/kiosque
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Configuration: getting-started/configuration.md
  - Features:
      - Article Extraction: features/article-extraction.md
      - Bookmark Management: features/bookmark-management.md
      - TUI Guide: features/tui-guide.md
  - Integrations:
      - Raindrop.io: integrations/raindrop.md
      - GitHub Stars: integrations/github.md
  - Websites:
      - Supported Sites: websites/supported-sites.md
      - Authentication: websites/authentication.md
      - NYT Cookie Setup: websites/nyt-cookie-setup.md
      - Adding Sites: websites/adding-sites.md
  - Development:
      - Architecture: development/architecture.md
      - Contributing: development/contributing.md
  - Troubleshooting: troubleshooting.md