mkdocs.yml

site_name: Material for Mkdocs - Repo Template by @lorebooks-wiki
site_author: Recap Time Squad
site_url: https://mkdocs-material.templates.lorebooks.wiki
copyright: >-
  Copyright (c) 2023-present Recap Time Squad and contributors.
  Content licensed under CC-BY-SA-4.0

repo_name: lorebooks-wiki/mkdocs-material-template
repo_url: https://github.com/lorebooks-wiki/mkdocs-material-template
edit_uri: blob/main/docs/

# Theme settings
theme:
  name: material
  custom_dir: overrides
  icon:
    logo: octicons/book-16
    # TODO: Use Material icons instead of this
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  favicon: assets/branding/default-favicon_512.png
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# plugins
plugins:
  - search
  - blog:
      post_url_format: "{slug}"
      post_url_max_categories: 2
      post_slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
      draft_if_future_date: true
      authors_file: "{blog}/authors.yml"
  - rss:
      enabled: !ENV [CI, false]
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags

# extras
extra:
  hcb:
    org_name: Community Lorebooks
    org_slug: lorebooks-wiki
    parent_org_name: Recap Time Squad
    parent_org_slug: recaptime-dev
  footer_links:
    - label: Use as template on GitHub
      href: https://github.com/lorebooks-wiki/mkdocs-material-template/generate
    - label: Fork on GitLab SaaS
      href: https://gitlab.com/lorebooks-wiki/templates/mkdocs-material/-/forks/new
    - label: Learn more about Community Lorebooks
      href: https://lorebooks.wiki
    - label: "Hey, what's HCB?"
      href: https://hackclub.com/fiscal-sponsorship
extra_css:
  - assets/stylesheets/theme.css