coppafisher/mkdocs.yml at main · paulshuker/coppafisher · 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
85
86
87
88
89
90
91
92
93
94
95
site_name: Coppafisher Documentation
repo_name: Coppafisher
repo_url: https://github.com/paulshuker/coppafisher

theme:
  name: material
  logo: images/logo.svg
  favicon: images/logo.png

  icon:
    repo: fontawesome/brands/github

  features:
    # Cool section selection at top (sticky makes tabs stay shown when scrolling)
    - navigation.tabs
    - navigation.tabs.sticky
    # Code blocks
    - content.code.annotation
    # Copy code button
    - content.code.copy

  language: en

  palette:
    # Palette toggle for dark mode
    - scheme: slate
      primary: teal
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode

    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

nav:
  - Getting started: index.md
  - Usage:
    - Basic Usage: basic_usage.md
    - Advanced Usage: advanced_usage.md
  - Diagnostics: diagnostics.md
  - Export: export.md
  - Method:
    - Overview: overview.md
    - Find Spots: find_spots.md
    - Stitch: stitch.md
    - Registration: register.md
    - Call Spots: call_spots.md
    - OMP: omp.md
  - Troubleshoot: troubleshoot.md
  - Glossary: glossary.md
  - Migration: migration.md
  - Contributing: contributing.md

# This part allows mathematics to be displayed LaTeX style, by using $...$ for in line or $$...$$ for multi-line.
markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  # Code snippets can now be embedded into the docs from coppafisher/docs.
  - pymdownx.snippets:
      base_path: ["coppafisher/docs"]
  # Code can be highlighted, for example python code by code block: ``` python ...``` or inline: `#!python ...`.
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
        alternate_style: true
  - pymdownx.highlight
  - pymdownx.inlinehilite
  # Footnote support
  - footnotes
  # Captions and aligned images support, re-sizeable images, and grids.
  - md_in_html
  - attr_list
  # Simple icons.
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search

# Required for LaTeX maths support.
extra_javascript:
  - javascripts/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - css/extra.css
  - https://unpkg.com/katex@0/dist/katex.min.css