mkdocs.yml

# Copyright (C) 2023 David Jones
# 
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/li/licenses/>.

site_name: "David's Memex"
site_url: https://djplaner.github.io/memex/
repo_url: https://github.com/djplaner/memex
site_author: David Jones
use_directory_urls: false

theme:
  name: material
  #  favicon: attachment/portrait.png
  favicon: assets/memex.png
  logo: assets/spider_web.png
  palette:
  - scheme: collections
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  custom_dir: .overrides
  language: en
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
    - navigation.tracking
    - content.tabs.links
    - navigation.expand 
    - navigation.indexes
    - navigation.footer
    - navigation.sections
    - toc.follow
    - header.autohide
    - search.suggest
markdown_extensions: 
  - pymdownx.arithmatex:
      generic: true
  - attr_list # https://squidfunk.github.io/mkdocs-material/reference/images/
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid 
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - tables
#  - nl2br # newline-to-break 
  - toc:
      permalink: '#' # heading anchor 
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
  - admonition
  - codehilite:
      guess_lang: false
      linenums: false
  - footnotes
  - meta
  - def_list
#  - pymdownx.arithmatex:thinking: 
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist
  - pymdownx.tilde
plugins:
  - glightbox
  - search
  - roamlinks 
    #- autolinks 
  - exclude:
      glob:
        - "*.tmp"
        - "*.pdf"
        - "*.gz"
      regex:
        - '.*\.(tmp|bin|tar)$'
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js
extra:
  analytics:
    provider: google
    property: G-FRPL9T01XP
  social:
#  - icon: fontawesome/brands/twitter
#    link: https://twitter.com/djplaner
  - icon: fontawesome/brands/mastodon
    link: https://indieweb.social/@djplaner
  - icon: fontawesome/brands/github
    link: https://github.com/djplaner

nav:
  - Home: 
    - index.md
    - Colophon: colophon/colophon.md
  - Seek: 
    - seek/seek.md
    - Triage list: seek/seek-triage.md
  - Sense: 
    - sense/sense.md
    - Abstractions:
      - BAD: sense/CASA/bad.md
      - CASA: sense/CASA/casa.md
      - Herding Cats: sense/Bricolage/herding-cats.md
      - Know thy student: sense/CASA/know-thy-student.md
      - nodt: sense/nodt/nodt.md
      - Representations: sense/Representations/representations.md
      - Sharing design knowledge: sense/Sharing-design-knowledge/sharing-design-knowledge.md
    - Concepts: sense/concepts/concepts.md
    - Topics:
      - AI: sense/AI/AI.md
      - Computing: sense/computing/computing.md
      - Design: sense/Design/design.md
      - FLOSS/FOSS: sense/computing/floss.md
      - Learning: sense/Learning/learning.md
      - Python: sense/Python/python.md
      - Relational: sense/relational/relational.md
      - Research: sense/Research/research.md
      - Society: sense/Society/society.md
      - Web development: sense/Web-development/web-development.md
    - Tasks:
      - Conferences: sense/Conferences/conferences.md
      - Loose: sense/loose/loose.md
      - Paper Ideas: sense/Paper-Ideas/paper-ideas.md
      - Paper Summaries: sense/Paper-Summaries/paper-summaries.md
      - Recipes: sense/Recipes/recipes.md
      - Work: sense/work/work-categories.md
    - Teaching:
      - sense/Teaching/teaching.md
      - Quality and teaching: sense/Quality-and-teaching/quality-and-teaching.md
#    - Principles
#    - Society
  - Share: 
    - Overview: share/share.md
    - Blog: share/blog/blog-posts.md 
  - Birding:
    - Birding: sense/birdwatching/birding.md 
  - Gardens:
    - Gardens: sense/landscape-garden/gardens.md