codex/mkdocs.yml at main · svanderweerd/codex · 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
site_name: Codex Astrum

# TODO: implement https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin for better nav
nav:
  - Introduction: index.md
  - Health:
      - Sleep: health/sleep.md
      - Fitness: health/fitness.md
  - Projects:
      - Gitlab analyzer:
          - projects/glab-analyzer/index.md
  - Coding:
      - Coding basics:
          - coding/basics/index.md
          - Setup coding environment: coding/basics/setup-coding-env.md
      - Languages:
          - Python:
              - coding/python/index.md
              - Python setup: coding/python/python-setup.md
              - Project templates:
                  - Web apps: coding/python/project_templates/web_apps.md
              - Data structures: coding/python/data-structures.md
              - Logging: coding/python/logging.md
              - DB handling: coding/python/db-handling.md
              - Libraries:
                  - Alembic: coding/python/libraries/alembic.md
                  - FastAPI: coding/python/libraries/fastapi.md
                  - Pydantic: coding/python/libraries/pydantic.md
                  - SQLAlchemy: coding/python/libraries/sqlalchemy.md
                  - Uvicorn: coding/python/libraries/uvicorn.md
          - SQL:
              - Postgres: coding/sql/pg.md
      - Software Architecture:
          - Repository pattern: coding/architecture/repository-pattern.md
          - Domain Driven Design: coding/architecture/ddd.md
          - Entity relationship modelling: coding/architecture/entity-relationship.md
  - MacOs:
      - macos/index.md
      - Libraries:
          - Tree: macos/libraries/tree.md
  - Tooling:
      - MkDocs: tooling/setup-mkdocs.md
      - Bash: tooling/bash.md
      - Git: tooling/git.md
      - Intellij IDEA: tooling/intellij-idea.md
  - DevOps:
      - devops/index.md
      - devops/docker.md

plugins:
  - search
  - autolinks
  - git-revision-date-localized:
      type: timeago
  - minify:
      minify_html: true
  - section-index
  - encryptcontent:
      title_prefix: '[lock] '
      button_class: 'md-search__icon'
  - tags

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - meta
  - md_in_html
  - def_list
  - toc:
      permalink: true
      baselevel: 2
  - tables
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

theme:
  name: material
  font: # remove if you want default (Roboto Mono)
    text: Montserrat
  features:
    - content.code.annotate
    - navigation.instant
    - navigation.top
    - search.suggest
    - search.highlight
  palette:
    # light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: blue grey
      accent: light blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: blue grey
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode