nnnotes/mkdocs.yml at main · MetaSekaiLab/nnnotes · 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
site_name: nnnotes
site_description: Offline data toolkit for BanG Dream! Our Notes game files
site_url: https://metasekailab.github.io/nnnotes/
repo_url: https://github.com/MetaSekaiLab/nnnotes
repo_name: MetaSekaiLab/nnnotes
edit_uri: edit/main/docs/
copyright: MIT License

theme:
  name: material
  features:
    - content.code.copy
    - navigation.sections
    - navigation.top
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Light mode

nav:
  - Home: index.md
  - Tutorial:
      - Quick start: quickstart.md
  - How-to guides:
      - Configure nnnotes: configuration.md
      - Export stories and lives: export.md
      - Build an ournotes-player site: site.md
      - Export every asset: assets.md
      - Japanese release: jp.md
      - Music data: music-data.md
  - Reference:
      - Commands: cli.md
      - Command outputs: commands.md
      - JSON schemas: schemas.md
      - Python API: api.md
      - Contracts: contracts.md
      - Stages: stages.md
      - Views: views.md
      - Replay data: replay.md
      - UI library: ui.md
  - Explanation:
      - Architecture: architecture.md
      - Determinism: determinism.md
      - Validation: validation.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: null
            filters: public
            heading_level: 3
            members_order: source
            separate_signature: true
            show_root_heading: true
            show_root_full_path: true
            show_source: false
            show_signature_annotations: true
            show_symbol_type_heading: true

validation:
  links:
    anchors: warn