condash-python/mkdocs.yml at main · vcoeur/condash-python · 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
site_name: condash-python
site_url: https://condash-python.vcoeur.com/
site_description: Standalone desktop dashboard for markdown-based projects, incidents, and documents — live-rendered from the files you edit by hand. NiceGUI + FastAPI + pywebview build; retired in favour of the Rust/Tauri successor at condash.vcoeur.com.
site_author: Alice Voland
copyright: 'Developed by Alice Voland &middot; <a href="https://vcoeur.com">vcoeur.com</a> &middot; <a href="/legal/">Legal</a>'

repo_url: https://github.com/vcoeur/condash-python
repo_name: vcoeur/condash-python
edit_uri: edit/main/docs/

theme:
  name: material
  font: false
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.tabs.link
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - assets/stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vcoeur/condash
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/condash/

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md

  - Tutorials:
    - tutorials/index.md
    - First run: tutorials/first-run.md
    - Your first project: tutorials/first-project.md
    - A day with condash: tutorials/daily-loop.md

  - Guides:
    - guides/index.md
    - Configure the conception path: guides/configure-conception-path.md
    - Repositories and open-with buttons: guides/repositories-and-open-with.md
    - Use the embedded terminal: guides/terminal.md
    - Link items with wikilinks: guides/wikilinks.md
    - The knowledge tree: guides/knowledge-tree.md
    - Search your history: guides/search.md
    - Deliverables and PDFs: guides/deliverables.md
    - Multi-machine setup: guides/multi-machine.md
    - Extend the management skill: guides/skill-extensions.md

  - Reference:
    - reference/index.md
    - CLI: reference/cli.md
    - Config files: reference/config.md
    - README format: reference/readme-format.md
    - Status, steps, deliverables: reference/conception-convention.md
    - Mutation model: reference/mutations.md
    - Inline dev-server runner: reference/inline-runner.md
    - HTTP and WebSocket API: reference/http-api.md
    - Keyboard shortcuts: reference/shortcuts.md
    - Environment variables: reference/env.md
    - Management skill: reference/skill.md

  - Explanation:
    - explanation/index.md
    - Why Markdown-first: explanation/why-markdown.md
    - Internals: explanation/internals.md

  - Legal: legal.md