dermixen/mkdocs.yml at main · mmacy/dermixen · 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
site_name: Dermixen
site_description: >-
  A studio mix-authoring app: drag tracks onto a timeline, get automatic
  beatmatched transitions, edit them, and render one continuous mix.
site_url: https://mmacy.github.io/dermixen/
repo_url: https://github.com/mmacy/dermixen
repo_name: mmacy/dermixen

theme:
  name: material
  # The app icon, copied from packaging/icon/dermixen.svg by scripts/make-icon.sh.
  logo: images/dermixen-icon.svg
  favicon: images/dermixen-icon.svg
  # The site never requests a font from Google Fonts.
  font: false
  features:
    # A button in the corner of every code block copies its text.
    - content.code.copy
  palette:
    # The toggle switches between the light and dark schemes, and the site
    # remembers the reader's choice.
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# The site's colors, taken from the app icon. See the comment at the top of
# the stylesheet.
extra_css:
  - stylesheets/dermixen.css

markdown_extensions:
  # Syntax highlighting for fenced and inline code. highlight tokenizes with
  # Pygments, superfences enables the ```lang fences, and inlinehilite colors
  # `#!lang ...` inline code.
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences

strict: true

validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    absolute_links: warn
    unrecognized_links: warn
    anchors: warn

nav:
  - Home: README.md
  - Tutorials:
      - Your first mix: tutorials/your-first-mix.md
      - Editing a mix in the window: tutorials/editing-a-mix-in-the-window.md
  - How-to guides:
      - Scan your music: how-to/scan-your-music.md
      - Find tracks for a mix: how-to/find-tracks-for-a-mix.md
      - Build a mix from a tracklisting: how-to/build-a-mix-from-a-tracklisting.md
      - Check a transition by ear: how-to/check-a-transition-by-ear.md
      - Change a transition: how-to/change-a-transition.md
      - Fix a beat grid: how-to/fix-a-beat-grid.md
      - Level the tracks: how-to/level-the-tracks.md
      - Relink moved files: how-to/relink-moved-files.md
      - Drive Dermixen from a script: how-to/drive-dermixen-from-a-script.md
      - Measure the analyzers: how-to/measure-the-analyzers.md
      - Build from source: how-to/build-from-source.md
  - Explanation:
      - How a mix fits together: explanation/how-a-mix-fits-together.md
      - What you hear is what renders: explanation/what-you-hear-is-what-renders.md
      - How analysis is trusted: explanation/how-analysis-is-trusted.md
      - The command and agents: explanation/the-command-and-agents.md
  - Reference:
      - The dermixen command: cli.md
      - The window: window.md
      - The library: library.md
      - The project file: project-file.md
      - Settings: settings.md
      - Ground truth for the scoreboard: ground-truth.md
      - Test fixtures: fixtures.md

plugins:
  - search