grobid/mkdocs.yml at master · grobidOrg/grobid · 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
site_name: GROBID Documentation
repo_url: https://github.com/kermitt2/grobid/
repo_name: GitHub

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

site_description: Documentation for GROBID
docs_dir: doc
extra_css:
  - css/custom.css

extra_javascript:
    - doc/readthedocs-search.js

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences

plugins:
    - search
nav:
  - Home: 'index.md'
  - Getting Started:
    - 'Quick start': 'getting_started.md'
    - 'Run with Docker': 'Grobid-docker.md'
    - 'Troubleshooting and FAQ': 'Frequently-asked-questions.md'
  - User Guide:
    - 'Using the REST API': 'Grobid-service.md'
    - 'Understanding the output (TEI)': 'TEI-encoding-of-results.md'
    - 'PDF coordinates': 'Coordinates-in-PDF.md'
    - 'Configuration': 'Configuration.md'
    - 'Consolidation service': 'Consolidation.md'
    - 'Specialized processes': 'Grobid-specialized-processes.md'
  - About:
    - 'Introduction': 'Introduction.md'
    - 'How GROBID works': 'Principles.md'
    - 'Benchmarks': 'benchmarks/Benchmarking.md'
    - 'References': 'References.md'
    - 'Licence': 'License.md'
  - Developer Guide:
    - 'Build from source': 'Install-Grobid.md'
    - 'Training and evaluating models': 'Training-the-models-of-Grobid.md'
    - 'End-to-end evaluation': 'End-to-end-evaluation.md'
    - 'Deep Learning models': 'Deep-Learning-models.md'
    - 'Developer notes': 'Notes-grobid-developers.md'
    - 'Recompiling CRF libraries': 'Recompiling-and-integrating-CRF-libraries.md'
  - Annotation Guidelines:
    - 'General principles': 'training/General-principles.md'
    - 'Segmentation model': 'training/segmentation.md'
    - 'Fulltext model': 'training/fulltext.md'
    - 'Header model': 'training/header.md'
    - 'Bibliographical references': 'training/Bibliographical-references.md'
    - 'Affiliation-address model': 'training/affiliation-address.md'
    - 'Date model': 'training/date.md'
  - Benchmarking:
    - 'PubMed Central': 'benchmarks/Benchmarking-pmc.md'
    - 'bioRxiv': 'benchmarks/Benchmarking-biorxiv.md'
    - 'PLOS': 'benchmarks/Benchmarking-plos.md'
    - 'eLife': 'benchmarks/Benchmarking-elife.md'
    - 'Model comparison': 'benchmarks/Benchmarking-models.md'
  - Archive:
    - 'Batch mode (deprecated)': 'Grobid-batch.md'
    - 'Java library (deprecated)': 'Grobid-java-library.md'