mkdocs.yml

site_name: Kindle highlights & notes
site_url: https://josh-wong.github.io/kindle-highlights-notes/
site_description: Highlights and notes from books I have read or am currently reading on Kindle.

repo_name: josh-wong/kindle-highlights-notes
repo_url: https://github.com/josh-wong/kindle-highlights-notes/
edit_uri: blob/main/docs

plugins:
  - search
  - minify:
      minify_html: true
  - mkdocs-video:
      css_style:
        width: "100%"
        height: "300px" 
  # Enables TechDocs support in Backstage. However, many plugins need to be disabled for TechDocs to work properly.
  #- techdocs-core

markdown_extensions:
  - abbr
  - admonition
  # Add styles for buttons
  - attr_list
  # Add support for grid cards
  - md_in_html
  # Make admonitions collapsible
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  #- pymdownx.snippets:
  #    auto_append:
  #      - includes/glossary.md
  - pymdownx.superfences:
      custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      # Add link next to header that allows the user to get a permalink to the heading (still need to copy the URL in the address bar).
      permalink: true

theme:
  name: material
  #custom_dir: overrides
  favicon: assets/images/favicon.png
  logo: assets/images/mkdocs_kindle.png
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
  palette:
    - media: "(prefers-color-scheme)" # Palette toggle for automatic mode
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)" # Palette toggle for light mode
      scheme: 080f53
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: blue
      accent: blue
    - media: "(prefers-color-scheme: dark)" # Palette toggle for dark mode
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to system preference
      primary: blue
      accent: blue
  features:
    - announce.dismiss
    - content.tooltips
    - search.highlight
    - search.share
    - search.suggest
    - navigation.expand
    - navigation.footer
    #- navigation.indexes
    - navigation.instant
    #- navigation.sections
    #- navigation.tabs
    #- navigation.tabs.sticky
    - navigation.top
    - navigation.tracking

extra:
  analytics:
    provider: google
    property: G-PMP34RZWN2
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! Help me improve this page by <a href="https://github.com/josh-wong/kindle-highlights-notes/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">creating an issue in GitHub</a>.
  consent:
    title: Cookie consent
    description: >- 
      This site uses cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of the documentation and whether users find what they're searching for. With your consent, you're helping to improve this documentation and provide a better user experience.
    actions:
      - accept
      - manage
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/josh-wong
      name: josh-wong on GitHub
    - icon: fontawesome/brands/gitlab
      link: https://gitlab.com/josh-wong
      name: josh-wong on GitLab
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/wongjoshua
      name: Joshua Wong on LinkedIn
    - icon: fontawesome/brands/mastodon
      link: https://famichiki.jp/@josh
      name: josh on Mastodon
    - icon: fontawesome/brands/steam
      link: https://steamcommunity.com/id/hex080f53
      name: hex080f53 on Steam
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/080f53
      name: 080f53 on Twitter
  status:
    new: Recently added
    deprecated: Deprecated

extra_css:
  - stylesheets/extra.css

copyright: >
  &copy; 2021-2023 Josh Wong –
  <a href="#__consent">🍪Cookie settings</a>

#nav:
#  - Overview: 'index.md'
#  - Getting started: '01_getting-started.md'
#  - Installing the Zune software: '02_installing-the-zune-software.md'
#  - Connecting to the Zune software: '03_connecting-with-the-zune-software.md'
#  - Adding apps and games (Zune HD only): '04_adding-apps-and-games.md'
#  - Conclusion: '05_conclusion.md'
#  - References: '06_references.md'
#  - Contributions: '07_contributions.md'