mkdocs.yml

---
site_name: The Blue Book
site_description: My personal digital garden
site_author: Lyz
site_url: https://lyz-code.github.io/blue-book
nav:
  - Introduction: index.md
  - Projects: projects/projects.md
  - Activism:
      - Antifascism:
          - antifascism.md
          - Antifascist Actions: antifascist_actions.md
      - Anti-Transphobia: antitransphobia.md
      - Diversity, Equity and Inclusion:
          - diversity.md
          - Anonymous Feedback: anonymous_feedback.md
      - Feminism:
          - Privileges: feminism/privileges.md
      - Mentoring: mentoring.md
      - Free Knowledge: free_knowledge.md
  - Life Management:
      - life_management.md
      - Time Management: time_management.md
      - Task Management:
          - task_management.md
          - Task Management Tools: task_tools.md
          - Task Management Workflows: task_workflows.md
      - Interruption Management:
          - interruption_management.md
          - Work Interruption Analysis: work_interruption_analysis.md
          - Personal Interruption Analysis: personal_interruption_analysis.md
      - Week Management: week_management.md
      - Relationship Management: relationship_management.md
      - Money Management: money_management.md
      - News Management: news_management.md
      - Email Management:
          - email_management.md
          - Email Automation: email_automation.md
      - Music Management:
          - music_management.md
          - MusicBrainz: musicbrainz.md
      - Book Management: book_management.md
      - Map Management: map_management.md
      - Instant Messages Management: instant_messages_management.md
      - Process Automation:
          - process_automation.md
          - Virtual Assistant: virtual_assistant.md
      - Strategy: strategy.md
  - Health:
      - Sleep: sleep.md
      - Teeth:
          - teeth.md
          - Deep cleaning: teeth_deep_cleaning.md
      - Remote Working: remote_work.md
      - Fitness Tracker:
          - fitness_band.md
          - Amazfit Band 5: amazfit_band_5.md
  - Coding:
      - Learning to code:
          - code_learning.md
          - Frontend developer: front_learning.md
      - Generic Coding Practices:
          - Program Versioning:
              - versioning.md
              - Semantic Versioning: semantic_versioning.md
              - Calendar Versioning: calendar_versioning.md
          - Use warnings to evolve your code: use_warnings.md
          - Keep a Changelog: changelog.md
          - Writing good documentation: documentation.md
          - TDD: coding/tdd.md
      - Software Architecture:
          - SOLID: architecture/solid.md
          - Domain Driven Design:
              - architecture/domain_driven_design.md
              - Repository Pattern: architecture/repository_pattern.md
              - Service Layer Pattern: architecture/service_layer_pattern.md
          - Architecture Decision Record: adr.md
          - Database Architecture: architecture/database_architecture.md
          - ORM, Query Builder or Raw SQL: architecture/orm_builder_query_or_raw_sql.md
          - Microservices: architecture/microservices.md
          - Restful APIS: architecture/restful_apis.md
          - Redis: architecture/redis.md
      - Python:
          - python.md
          - Project Template:
              - coding/python/python_project_template.md
              - Command-line Project Template:
                  - coding/python/python_project_template/python_cli_template.md
                  - Configure SQLAlchemy for projects without flask: >-
                      coding/python/python_project_template/python_sqlalchemy_without_flask.md
              - Flask Project Template: >-
                  coding/python/python_project_template/python_flask_template.md
              - Microservices Project Template: >-
                  coding/python/python_project_template/python_microservices_template.md
              - Common configurations:
                  - Create the documentation repository: >-
                      coding/python/python_project_template/python_docs.md
                  - Load config from YAML: coding/python/python_config_yaml.md
                  - Configure SQLAlchemy to use the MariaDB/Mysql backend: >-
                      coding/python/python_project_template/python_sqlalchemy_mariadb.md
                  - Configure Docker to host the application: >-
                      coding/python/python_project_template/python_docker.md
          - Libraries:
              - Alembic: coding/python/alembic.md
              - asyncio: asyncio.md
              - Boto3: boto3.md
              - Click: coding/python/click.md
              - Dash: coding/python/dash.md
              - Dash Leaflet: coding/python/dash_leaflet.md
              - DeepDiff: coding/python/deepdiff.md
              - FactoryBoy: coding/python/factoryboy.md
              - Faker: coding/python/faker.md
              - FastAPI: fastapi.md
              - Flask: coding/python/flask.md
              - Flask Restplus: coding/python/flask_restplus.md
              - Folium: coding/python/folium.md
              - Feedparser: coding/python/feedparser.md
              - GitPython: coding/python/gitpython.md
              - Goodconf: goodconf.md
              - Jinja2: python_jinja2.md
              - mkdocstrings: coding/python/mkdocstrings.md
              - NetworkX: networkx.md
              - Pandas: coding/python/pandas.md
              - Passpy: coding/python/passpy.md
              - pexpect: pexpect.md
              - Prompt Toolkit:
                  - coding/python/prompt_toolkit.md
                  - REPL: prompt_toolkit_repl.md
                  - Full screen applications: prompt_toolkit_fullscreen_applications.md
              - Pydantic:
                  - coding/python/pydantic.md
                  - Pydantic Field Types: coding/python/pydantic_types.md
                  - Pydantic Validators: coding/python/pydantic_validators.md
                  - Pydantic Exporting Models: coding/python/pydantic_exporting.md
                  - Pydantic Validating Functions: coding/python/pydantic_functions.md
                  - Pydantic Factories: pydantic_factories.md
                  - Pydantic Mypy Plugin: coding/python/pydantic_mypy_plugin.md
              - Pypika: coding/python/pypika.md
              - Python Mysql: python_mysql.md
              - Plotly: coding/python/plotly.md
              - questionary: questionary.md
              - rich: rich.md
              - Ruamel YAML: coding/python/ruamel_yaml.md
              - Selenium: selenium.md
              - SQLAlchemy: coding/python/sqlalchemy.md
              - sqlite3: sqlite3.md
              - Redis-py: coding/python/redis-py.md
              - Requests: requests.md
              - Requests-mock: coding/python/requests_mock.md
              - Rq: coding/python/rq.md
              - sh: coding/python/sh.md
              - Talkey: talkey.md
              - Tenacity: tenacity.md
              - TinyDB: coding/python/tinydb.md
              - Yoyo: coding/python/yoyo.md
          - Type Hints: coding/python/type_hints.md
          - Logging: python_logging.md
          - Code Styling: coding/python/python_code_styling.md
          - Docstrings: coding/python/docstrings.md
          - Properties: python_properties.md
          - Package Management:
              - python_package_management.md
              - PDM: pdm.md
              - Pipenv: pipenv.md
              - Poetry: python_poetry.md
          - Lazy loading: lazy_loading.md
          - Plugin System: python_plugin_system.md
          - Profiling: python_profiling.md
          - Optimization: python_optimization.md
          - Anti-Patterns: coding/python/python_anti_patterns.md
          - Data Classes: coding/python/data_classes.md
          - Pytest:
              - coding/python/pytest.md
              - Parametrized testing: coding/python/pytest_parametrized_testing.md
              - Pytest-cases: coding/python/pytest_cases.md
              - Pytest-HttpServer: pytest_httpserver.md
          - Python Snippets: coding/python/python_snippets.md
      - Frontend Development: fronted_development.md
      - Vue.js:
          - vuejs.md
          - Vue snippets: vue_snippets.md
          - Vuetify: vuetify.md
          - Development tools:
              - Cypress: cypress.md
              - Vite: vite.md
              - Vitest: vitest.md
      - Git: git.md
      - Park programming: park_programming.md
      - JSON: coding/json/json.md
      - SQL: coding/sql/sql.md
      - SQLite: sqlite.md
      - YAML: coding/yaml/yaml.md
      - Promql: coding/promql/promql.md
      - HTML: html.md
      - CSS: css.md
      - Javascript:
          - coding/javascript/javascript.md
          - Javascript snippets: javascript_snippets.md
          - MermaidJS: mermaidjs.md
      - React: coding/react/react.md
      - Issues: issues.md
  - DevOps:
      - devops/devops.md
      - Infrastructure as Code:
          - Helm:
              - devops/helm/helm.md
              - Helm Installation: devops/helm/helm_installation.md
              - Helm Commands: devops/helm/helm_commands.md
              - Helm Secrets: devops/helm/helm_secrets.md
              - Helm Git: helm_git.md
          - Helmfile: devops/helmfile.md
          - Terraform: terraform.md
          - Ansible Snippets: ansible_snippets.md
      - Infrastructure Solutions:
          - Kubernetes:
              - devops/kubernetes/kubernetes.md
              - Architecture: devops/kubernetes/kubernetes_architecture.md
              - Resources:
                  - Namespaces: devops/kubernetes/kubernetes_namespaces.md
                  - Pods: devops/kubernetes/kubernetes_pods.md
                  - ReplicaSets: devops/kubernetes/kubernetes_replicasets.md
                  - Deployments: devops/kubernetes/kubernetes_deployments.md
                  - Horizontal Pod Autoscaling: >-
                      devops/kubernetes/kubernetes_hpa.md
                  - Volumes: devops/kubernetes/kubernetes_volumes.md
                  - Services: devops/kubernetes/kubernetes_services.md
                  - Labels: devops/kubernetes/kubernetes_labels.md
                  - Annotations: devops/kubernetes/kubernetes_annotations.md
                  - Ingress: devops/kubernetes/kubernetes_ingress.md
                  - Operators: devops/kubernetes/kubernetes_operators.md
                  - Jobs: devops/kubernetes/kubernetes_jobs.md
              - Kubectl:
                  - devops/kubectl/kubectl.md
                  - Kubectl Installation: devops/kubectl/kubectl_installation.md
                  - Kubectl Commands: devops/kubectl/kubectl_commands.md
              - Additional Components:
                  - Metrics Server: devops/kubernetes/kubernetes_metric_server.md
                  - Ingress Controller: >-
                      devops/kubernetes/kubernetes_ingress_controller.md
                  - External DNS: devops/kubernetes/kubernetes_external_dns.md
                  - Cluster Autoscaler: >-
                      devops/kubernetes/kubernetes_cluster_autoscaler.md
                  - Dashboard: devops/kubernetes/kubernetes_dashboard.md
                  - Storage Driver: devops/kubernetes/kubernetes_storage_driver.md
                  - Vertical Pod Autoscaler: >-
                      devops/kubernetes/kubernetes_vertical_pod_autoscaler.md
              - Networking: devops/kubernetes/kubernetes_networking.md
              - Debugging: kubernetes_debugging.md
              - Tools:
                  - devops/kubernetes/kubernetes_tools.md
                  - Krew: krew.md
                  - Ksniff: ksniff.md
                  - Mizu: mizu.md

          - AWS:
              - devops/aws/aws.md
              - AWS Snippets: aws_snippets.md
              - Security groups workflow: devops/aws/security_groups.md
              - EKS: devops/aws/eks.md
              - IAM:
                  - devops/aws/iam/iam.md
                  - IAM Commands: devops/aws/iam/iam_commands.md
                  - IAM Debugging: devops/aws/iam/iam_debug.md
              - S3: devops/aws/s3.md
              - WAF: aws_waf.md
      - Continuous Integration:
          - devops/ci.md
          - Linters:
              - Alex: devops/alex.md
              - Flakeheaven: devops/flakeheaven.md
              - Flake8: devops/flake8.md
              - Markdownlint: devops/markdownlint.md
              - Proselint: devops/proselint.md
              - Yamllint: devops/yamllint.md
              - Write Good: devops/write_good.md
          - Formatters:
              - Black: devops/black.md
              - Yamlfix: yamlfix.md
              - Pyment: pyment.md
          - Type Checkers:
              - Mypy: devops/mypy.md
          - Security Checkers:
              - Safety: devops/safety.md
              - Bandit: devops/bandit.md
          - Dependency managers:
              - Pip-tools: devops/pip_tools.md
      - Automating Processes:
          - cookiecutter: linux/cookiecutter.md
          - cruft: linux/cruft.md
      - Monitoring:
          - Monitoring Comparison: monitoring_comparison.md
          - Prometheus:
              - devops/prometheus/prometheus.md
              - Architecture: devops/prometheus/prometheus_architecture.md
              - Prometheus Operator: devops/prometheus/prometheus_operator.md
              - Prometheus Install: devops/prometheus/prometheus_installation.md
              - AlertManager: devops/prometheus/alertmanager.md
              - Blackbox Exporter: devops/prometheus/blackbox_exporter.md
              - Elasticsearch Exporter: elasticsearch_exporter.md
              - Node Exporter: devops/prometheus/node_exporter.md
              - Instance sizing analysis: devops/prometheus/instance_sizing_analysis.md
              - Prometheus Troubleshooting: >-
                  devops/prometheus/prometheus_troubleshooting.md
      - API Management:
          - devops/api_management.md
          - Kong: devops/kong/kong.md
      - Scrum:
          - scrum.md
          - Templates:
              - Refinement Template: refinement_template.md
  - Operating Systems:
      - Linux:
          - Linux Snippets: linux_snippets.md
          - afew: afew.md
          - alot: alot.md
          - ActivityWatch: activitywatch.md
          - beancount: beancount.md
          - Beets: beets.md
          - brew: linux/brew.md
          - Docker: docker.md
          - dunst: dunst.md
          - Dynamic DNS: self_hosted/dynamicdns.md
          - elasticsearch: linux/elasticsearch.md
          - fail2ban: linux/fail2ban.md
          - Gajim: gajim.md
          - Github cli: gh.md
          - goaccess: goaccess.md
          - google chrome: linux/google_chrome.md
          - Graylog: graylog.md
          - HAProxy: linux/haproxy.md
          - Hard drive health: docs/linux/hard_drive_health.md
          - Hushboard: husboard.md
          - hypothesis: linux/hypothesis.md
          - Jellyfin: jellyfin.md
          - ffmpeg: ffmpeg.md
          - Kitty: kitty.md
          - LUKS: linux/luks/luks.md
          - mbsync: mbsync.md
          - mkdocs: linux/mkdocs.md
          - Modipy: modipy.md
          - monica: linux/monica.md
          - notmuch: notmuch.md
          - nodejs: linux/nodejs.md
          - Oracle Database: oracle_database.md
          - Peek: peek.md
          - Profanity: profanity.md
          - rm: linux/rm.md
          - Rtorrent: rtorrent.md
          - Syncthing: linux/syncthing.md
          - Tahoe-LAFS: tahoe.md
          - Vim:
              - vim.md
              - Tabs vs Buffers: vim_tabs.md
              - Vim Plugins: linux/vim/vim_plugins.md
              - Write Neovim Plugins: write_neovim_plugins.md
          - Wake on Lan: wake_on_lan.md
          - Wallabag: wallabag.md
          - Wireguard: linux/wireguard.md
          - Wireshark: wireshark.md
          - ZFS: linux/zfs.md
          - zip: linux/zip.md
      - Android:
          - cone: cone.md
          - GadgetBridge: gadgetbridge.md
          - OsmAnd: osmand.md
          - Signal: signal.md
  - Arts:
      - Writing:
          - writing/writing.md
          - Grammar and Orthography: writing/orthography.md
          - Writing Style: writing_style.md
          - Digital Gardens:
              - digital_garden.md
              - Build your own Digital Garden: writing/build_your_own_wiki.md
              - Forking this garden: forking_this_wiki.md
      - Cooking:
          - cooking.md
          - Cooking Basics: cooking_basics.md
      - Pilates:
          - pilates.md
      - Aerial Silk: aerial_silk.md
      - Dancing:
          - Rave Dances: dancing/rave_dances.md
          - Shuffle:
              - Basics: dancing/shuffle_basics.md
              - Kicks: dancing/shuffle_kicks.md
              - Spins: dancing/shuffle_spins.md
          - Cutting Shapes: dancing/cutting_shapes_basics.md
      - Meditation: meditation.md
      - Video Gaming:
          - The Battle for Wesnoth:
              - The Battle for Wesnoth: wesnoth.md
              - Loyalist: wesnoth_loyalist.md
              - Rebels: wesnoth_rebels.md
              - Northeners: wesnoth_northerners.md
      - Board Gaming:
          - Regicide: regicide.md
      - Drawing:
          - drawing/drawing.md
          - Exercise Pool: drawing/exercise_pool.md
      - Origami: origami.md
      - Fun: fun.md
      - Book Binding: book_binding.md
      - Emojis: emojis.md
  - Science:
      - Data Analysis:
          - Recommender Systems: >-
              data_analysis/recommender_systems/recommender_systems.md
      - Psychology:
          - The XY Problem: psychology/the_xy_problem.md
      - Botany:
          - Trees: botany/trees.md
  - Contact: contact.md

plugins:
  - search
  - autolinks
  - git-revision-date-localized:
      type: timeago
  - minify:
      minify_html: true
  - section-index
  - mkdocs-newsletter

markdown_extensions:
  - abbr
  - admonition
  - meta
  - def_list
  - toc:
      permalink: ⚑
      baselevel: 2
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: '!!python/name:pymdownx.emoji.to_svg'
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
theme:
  name: material
  custom_dir: theme
  logo: img/logo.bmp
  features:
    - navigation.instant
    - navigation.top
    - content.code.annotate

  palette:
    # Light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: blue grey
      accent: light blue
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    # Dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: blue grey
      accent: light blue
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css
  - stylesheets/links.css

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/lyz-code
    - icon: fontawesome/solid/rss
      link: https://lyz-code.github.io/blue-book/newsletter/0_newsletter_index

repo_name: lyz-code/blue-book
repo_url: https://github.com/lyz-code/blue-book