SequenceAligner/mkdocs.yml at main · bibymaths/SequenceAligner · 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: SequenceAligner
site_description: "Documentation for a simple alignment tool for DNA sequences."
site_author: "Abhinav Mishra"
site_url: https://bibymaths.github.io/SequenceAligner
use_directory_urls: false
repo_url: https://github.com/bibymaths/SequenceAligner
repo_name: bibymaths/SequenceAligner

theme:
  name: material
  language: en
  font:
    text: Ubuntu           # The font for standard paragraph text
    code: Fira Code        # The font for code blocks
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo # Change this to your brand color!
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy
    - toc.integrate

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Input: input.md
  - Algorithms:
      - Overview: processes.md
      - FM-Index & Seeding: fmindex.md
      - Alignment Engine: alignment.md
  - Output: outputs.md
  - CLI Reference: cli.md
  - Performance & Parallelism: performance.md
  - Benchmarking: benchmarks.md
  - About: about.md
  - C++ API: https://bibymaths.github.io/SequenceAligner/api/index.html

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: true
      toc_depth: 2
  - admonition
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - stylesheets/extra.css

plugins:
  - search

watch:
  - docs

copyright: >
  Copyright &copy; 2025 <a href="https://bibymaths.github.io">Abhinav Mishra</a>.