filetype-detector/mkdocs.yml at main · devcomfort-works/filetype-detector · 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
site_name: filetype-detector Documentation
site_description: A Python library for detecting file types using multiple inference strategies
site_author: devcomfort
site_url: https://filetype-detector.readthedocs.io/

repo_name: filetype-detector
repo_url: https://github.com/devcomfort/filetype-detector
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search:
      lang: en

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - Tutorial:
    - Getting Started: getting-started.md
  - How-to Guides:
    - Overview: how-to/index.md
    - Choose an Inferencer: how-to/choose-an-inferencer.md
    - Process Files in Bulk: how-to/process-files-in-bulk.md
    - Extend with a Custom Inferencer: how-to/extend-with-custom-inferencer.md
    - Examples and Patterns: user-guide.md
  - Reference:
    - Overview: reference/index.md
    - BaseInferencer: api/base_inferencer.md
    - AutoInferencer: api/auto_inferencer.md
    - LexicalInferencer: api/lexical_inferencer.md
    - MagicInferencer: api/magic_inferencer.md
    - MagikaInferencer: api/magika_inferencer.md
    - HybridInferencer: api/hybrid_inferencer.md
    - FAQ and Troubleshooting: faq.md
  - Explanation:
    - Overview: explanation/index.md
    - Inference Strategies: explanation/inference-strategies.md
    - Architecture: architecture.md
  - Project:
    - Contributing: contributing.md