reference/mkdocs.yml at master · thilke-labs/reference · 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
site_name: book-to-skill
site_description: >-
  Turn any book, PDF or EPUB into a structured agent skill for Claude Code,
  GitHub Copilot CLI and Amp — frameworks and decision rules, loaded on demand.
site_url: https://booktoskill.is-a.dev/
repo_url: https://github.com/virgiliojr94/book-to-skill
repo_name: virgiliojr94/book-to-skill
edit_uri: ""

# index.md is a committed landing page. Guide (README.md) and Skill Reference
# (SKILL.md) are assembled from the repo root at build time, so prose docs stay
# single-source. See .github/workflows/deploy-docs.yml.

theme:
  name: material
  custom_dir: overrides
  logo: assets/logo.png
  favicon: assets/logo.png
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.instant
    - navigation.top
    - navigation.footer
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

nav:
  - Home: index.md
  - Guide: guide.md
  - How it works: how-it-works.md
  - Usage: usage.md
  - Install: install.md
  - FAQ: faq.md
  - Architecture: architecture.md
  - Performance: performance.md
  - Skill Reference: skill-reference.md

plugins:
  # `search` is on by default, but naming any plugin replaces the default list.
  - search
  # No `social` plugin: the share card is a hand-made docs/assets/og-card.jpg and
  # overrides/main.html emits the og:/twitter: tags around it.
  #
  # The docs pages were renamed to lowercase kebab-case slugs; keep the old
  # SHOUTING_CASE URLs alive so existing inbound links and bookmarks resolve.
  - redirects:
      redirect_maps:
        HOW_IT_WORKS.md: how-it-works.md
        USAGE.md: usage.md
        INSTALL.md: install.md
        FAQ.md: faq.md
        ARCHITECTURE.md: architecture.md
        PERFORMANCE.md: performance.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: true