escapepod-rs/zensical.toml at main · rnabioco/escapepod-rs · 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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
[project]
site_name = "escapepod-rs"
site_description = "Rust library and CLI for Oxford Nanopore POD5 files"
site_url = "https://rnabioco.github.io/escapepod-rs/"
repo_url = "https://github.com/rnabioco/escapepod-rs"
repo_name = "rnabioco/escapepod-rs"
copyright = "Copyright &copy; 2025 RNA Bioscience Initiative"
extra_css = ["stylesheets/space.css"]

nav = [
  { "Home" = "index.md" },
  { "Getting Started" = [
    { "Installation" = "getting-started/installation.md" },
    { "Quick Start" = "getting-started/quickstart.md" },
  ] },
  { "CLI Reference" = [
    { "Overview" = "cli/index.md" },
    { "summary" = "cli/summary.md" },
    { "view" = "cli/view.md" },
    { "inspect" = "cli/inspect.md" },
    { "merge" = "cli/merge.md" },
    { "filter" = "cli/filter.md" },
    { "bam-filter" = "cli/bam-filter.md" },
    { "subset" = "cli/subset.md" },
  ] },
  { "Experimental" = [
    { "Overview" = "experimental/index.md" },
    { "repack" = "experimental/repack.md" },
    { "resquiggle" = "experimental/resquiggle.md" },
    { "demux" = "experimental/demux.md" },
  ] },
  { "Python API" = [
    { "Overview" = "python/index.md" },
    { "Reading Files" = "python/reading.md" },
    { "Writing Files" = "python/writing.md" },
    { "Signal Processing" = "python/signal.md" },
  ] },
  { "Rust Library" = [
    { "Overview" = "library/index.md" },
    { "Reading Files" = "library/reading.md" },
    { "Writing Files" = "library/writing.md" },
    { "Data Types" = "library/types.md" },
  ] },
  { "Rust API Reference" = "api/index.md" },
  { "File Format" = [
    { "Overview" = "format/index.md" },
    { "Container Structure" = "format/container.md" },
    { "Signal Compression" = "format/compression.md" },
  ] },
]

[project.theme]
features = [
  "navigation.sections",
  "navigation.expand",
  "navigation.top",
  "navigation.indexes",
  "search.suggest",
  "search.highlight",
  "content.code.copy",
  "content.code.annotate",
]

# "Space" theme — nebula purple + radioactive lime, on deep space. Dark scheme
# (slate) is listed first so it's the default; solar orange and the exact
# shades are layered in stylesheets/space.css. Toggle still switches to light.
[[project.theme.palette]]
scheme = "slate"
primary = "purple"
accent = "lime"
toggle.icon = "material/brightness-4"
toggle.name = "Switch to light mode"

[[project.theme.palette]]
scheme = "default"
primary = "purple"
accent = "deep-orange"
toggle.icon = "material/brightness-7"
toggle.name = "Switch to dark mode"

# Line numbers are opt-in per fence via `linenums="1"` (see docs authoring/
# code-blocks). We only tag actual code (Rust API/library examples); command,
# config, data, and output blocks stay clean. NOTE: `line_spans`/`anchor_linenums`
# reroute highlighting into an inline-span mode that suppresses the per-fence
# line-number gutter, so they are intentionally left off.
[project.markdown_extensions.pymdownx.highlight]
pygments_lang_class = true

[project.markdown_extensions.pymdownx.inlinehilite]

[project.markdown_extensions.pymdownx.snippets]

[[project.markdown_extensions.pymdownx.superfences.custom_fences]]
name = "mermaid"
class = "mermaid"
format = "pymdownx.superfences.fence_code_format"

[project.markdown_extensions.pymdownx.details]

[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true

[project.markdown_extensions.admonition]

[project.markdown_extensions.tables]

[project.markdown_extensions.toc]
permalink = true

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/rnabioco/escapepod-rs"