variantValidator/mkdocs.yml at master · openvar/variantValidator · 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
site_name: VariantValidator
site_description: Validate, normalise, map and format genetic sequence variant descriptions
site_url: https://variantvalidator.org
repo_name: openvar/variantValidator
repo_url: https://github.com/openvar/variantValidator

docs_dir: docs
use_directory_urls: false

theme:
  name: material
  language: en

markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md

  - Web Interface (VVweb):
      - Overview: vvweb/index.md
      - Validator: vvweb/validator.md
      - Batch Validator: vvweb/batch_validator.md
      - Gene2Transcripts: vvweb/gene2transcripts.md
      - LOVD HGVS Syntax Checker: vvweb/lovd-hgvs-syntax-checker.md

  - Installation:
      - Overview: installation/index.md
      - Linux & macOS: installation/installation.md
      - Windows (WSL2): installation/installation_windows.md
      - Docker: installation/docker.md
      - Configuration CLI: installation/configuration_cli.md
      - Troubleshooting: installation/configuration_troubleshooting.md

  - User Manual:
      - Overview: user-manual/index.md

      - VariantValidator:
          - CLI: user-manual/cli/variantvalidator_cli.md
          - Python API: user-manual/python-api/variantvalidator_python.md

      - VariantFormatter:
          - CLI: user-manual/cli/variantformatter_cli.md
          - Python API: user-manual/python-api/variantformatter_python.md

      - Gene2Transcripts:
          - CLI: user-manual/cli/gene2transcripts_cli.md
          - Python API: user-manual/python-api/gene2transcripts_python.md

      - LOVD HGVS Syntax Checker:
          - CLI: user-manual/cli/lovd-hgvs-syntax-checker-cli.md
          - Python API: user-manual/python-api/lovd-hgvs-syntax-checker-python.md

      - hgvs2reference:
          - Python API: user-manual/python-api/hgvs2reference_python.md

      - Reference:
          - Supported Input Formats: user-manual/reference/supported_inputs.md
          - Transcript Selection: user-manual/reference/transcript_selection.md
          - Output Formats: user-manual/reference/output_formats.md
          - Errors and Error Codes: user-manual/reference/errors_and_error_codes.md

  - REST API:
      - Overview: rest-vv/index.md
      - REST VariantValidator: rest-vv/rest_VariantValidator.md
      - REST VariantValidator2 (SHAIP): rest-vv/rest_VariantValidator2.md
      - LOVD HGVS Syntax Checker: rest-vv/lovd-hgvs-syntax-checker.md

plugins:
  - search

copyright: >
  Copyright © 2016–2026 VariantValidator Contributors