hellish/mkdocs.yml at main · Univers42/hellish · 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
# The docs site: https://univers42.github.io/hellish/
#
# The source of the site IS the wiki/ directory -- one set of pages, readable
# on GitHub and rendered by MkDocs, so the two can never drift. Built and
# deployed by .github/workflows/docs.yml on every push to main.
site_name: hellish
site_description: A from-scratch, almost-POSIX shell in C — minimalist-shell speed, bash-class features.
site_url: https://univers42.github.io/hellish/
repo_url: https://github.com/Univers42/hellish
repo_name: Univers42/hellish
edit_uri: edit/main/wiki/

docs_dir: wiki

# Working material that lives in wiki/ but is not part of the site: session
# notes, reference PDFs (19 MB), captured logs, the legacy readme collection.
exclude_docs: |
  context.md
  assets/pdfs/
  assets/logs/
  assets/manual/
  assets/readmes/
  assets/hellishrc.example

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: red
      toggle:
        icon: material/weather-night
        name: dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: red
      toggle:
        icon: material/weather-sunny
        name: light mode
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.suggest

markdown_extensions:
  - admonition
  - tables
  - pymdownx.superfences
  - pymdownx.highlight
  - toc:
      permalink: true

nav:
  - Home: index.md
  - What it is + Install: product.md
  - The manual: manual.md
  - Builtins reference:
      - All builtins: builtins/index.md
      - cd, in depth: builtins/cd.md
  - Plugins: plugins.md
  - Interactive Experience: interactive.md
  - Scripting & Compatibility: scripting.md
  - Benchmarks: benchmarks.md
  - Architecture: architecture.md
  - Performance: performance.md
  - Platforms: platforms.md
  - Troubleshooting: troubleshoot/README.md
  - Fix write-ups: fixes/README.md