CodingHandbook/mkdocs.yml at main · Meridex/CodingHandbook · 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
site_name: Meridex Research Software Handbook
site_description: Official software engineering handbook for the Meridex research group
site_author: Meridex Group
repo_url: https://github.com/Meridex/CodeHandbook
repo_name: Meridex/CodeHandbook
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.details
  - tables
  - attr_list

nav:
  - Home: index.md
  - Student Guide:
    - Introduction: student/01-introduction.md
    - Git vs GitHub: student/02-git-vs-github.md
    - Workflow Overview: student/03-workflow-overview.md
    - Initial Setup: student/04-initial-setup.md
    - SSH Authentication: student/05-ssh.md
    - Cloning the Repository: student/06-clone.md
    - Daily Workflow: student/07-daily-workflow.md
    - Branches: student/08-branches.md
    - Commits: student/09-commits.md
    - Pushing: student/10-push.md
    - Pull Requests: student/11-pull-requests.md
    - Reviews: student/12-reviews.md
    - Merge Conflicts: student/13-merge-conflicts.md
    - Updating Branches: student/14-updating-branches.md
    - Common Mistakes: student/15-common-mistakes.md
    - FAQ: student/16-faq.md
    - Cheat Sheet: student/17-cheat-sheet.md
    - Exercises: student/18-exercises.md
  - Maintainer Guide:
    - Repository Creation: maintainer/01-repo-creation.md
    - Repository Settings: maintainer/02-repo-settings.md
    - Branch Protection: maintainer/03-branch-protection.md
    - Collaborator Management: maintainer/04-collaborators.md
    - Labels: maintainer/05-labels.md
    - Milestones: maintainer/06-milestones.md
    - Project Board: maintainer/07-project-board.md
    - Review Workflow: maintainer/08-review-workflow.md
    - Merge Strategy: maintainer/09-merge-strategy.md
    - Releases: maintainer/10-releases.md
    - Tags: maintainer/11-tags.md
    - Documentation Policy: maintainer/12-documentation-policy.md
    - Testing Policy: maintainer/13-testing-policy.md
    - CI Preparation: maintainer/14-ci-preparation.md
    - Backup Strategy: maintainer/15-backup-strategy.md
    - Archiving: maintainer/16-archiving.md
    - Public Transition: maintainer/17-public-transition.md
    - Student Onboarding: maintainer/18-student-onboarding.md
    - Student Offboarding: maintainer/19-student-offboarding.md
  - Appendices:
    - Research Software Principles: appendices/research-software-principles.md
    - Group Policies: appendices/group-policies.md
    - Glossary: appendices/glossary.md