classdock/mkdocs.yml at develop · hugo-valle/classdock · 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
site_name: ClassDock
site_description: Modern Python CLI for automating GitHub Classroom assignment management 🚀
site_url: https://hugo-valle.github.io/classdock/

repo_url: https://github.com/hugo-valle/classdock
repo_name: hugo-valle/classdock

docs_dir: docs-site

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.action.edit
    - content.action.view
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Configuration: getting-started/configuration.md
  - CLI Reference:
    - Overview: cli/overview.md
    - Assignment Commands: cli/assignments.md
    - Repository Commands: cli/repositories.md
    - Secret Management: cli/secrets.md
    - Automation Commands: cli/automation.md
  - Workflows:
    - Assignment Orchestrator: workflows/assignment-orchestrator.md
    - Automation Suite: workflows/automation-suite.md
    - Classroom URL Integration: workflows/classroom-url-integration.md
    - Cron Automation: workflows/cron-automation.md
    - Secrets Management: workflows/secrets-management.md
  - Development:
    - Contributing: development/contributing.md
    - Architecture: development/architecture.md
    - Testing: development/testing.md
    - Versioning: development/versioning.md
  - About:
    - Changelog: about/changelog.md
    - License: about/license.md

plugins:
  - search:
      lang: en

markdown_extensions:
  - toc:
      permalink: true
      title: On this page
  - tables
  - admonition
  - codehilite:
      css_class: highlight
  - footnotes
  - def_list
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/hugo-valle/classdock
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/classdock/

copyright: Copyright &copy; 2024 Hugo Valle