knowledge/mkdocs.yml at main · ftschindler/knowledge · 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
---
site_name: "Felix' knowledge base"
site_url: https://ftschindler.github.io/knowledge/
repo_url: https://github.com/ftschindler/knowledge
copyright: 'Content <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>, code MIT'
edit_uri: edit/main/docs/
extra_css:
- stylesheets/theme.css
theme:
  name: material
  # overrides/ adds the metadata card to the right-hand rail; see
  # about/tech_stack.md. It overrides Material blocks rather than copying its
  # partials, so a theme upgrade cannot silently leave a stale copy behind.
  custom_dir: overrides
  features:
  - content.action.edit
  # Render a directory's index.md when its section is clicked in the nav, rather
  # than only expanding the section. Requires the file to be named index.md.
  - navigation.indexes
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
hooks:
- hooks/publish_siblings.py
- hooks/concept_genre.py
# A concept's declared sources, rendered as the footnotes its prose cites.
- hooks/concept_sources.py
plugins:
- search
- awesome-pages
# Dated posts addressed to a reader, in `blog/` beside the bundle rather than in
# it; hooks/publish_siblings.py injects them. The plugin discovers posts by path
# and runs its own `on_files` late (priority -50) so injected files are already
# in the list, which is what makes the sibling layout work.
- blog
# The domain axis: folders carry a page's nature, tags carry its subject, so the
# tag listing is the only place the bundle can be read by subject. Listings are
# rendered wherever a page carries the `material/tags` marker; see about/tags.md.
- tags
- obsidian-support
# Backlinks are a property of the bundle: a concept is worth knowing about
# because other concepts point at it. Nothing in the bundle ever links to a post,
# by design, so on `blog/` the section is always empty and sits between the page
# and the post list the blog plugin appends.
- backlinks_section:
    ignore_links_to:
    - blog/**
- excalidraw
- git-revision-date-localized:
    enable_creation_date: true
    # The blog needs an entrypoint page and does not deserve an introduction, so
    # the blog plugin writes its own `# Blog` stub into the bundle directory.
    # That stub is gitignored, so it has no history to read and would warn on
    # every build, which fails --strict.
    exclude:
    - blog/index.md
- glightbox
markdown_extensions:
- admonition
# A concept declares its sources in frontmatter and cites them by id from the
# prose; hooks/concept_sources.py writes the definitions these render.
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- toc:
    permalink: true