workshop-template/myst.yml at main · jupyter-book/workshop-template · 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
# See docs at: https://mystmd.org/guide/frontmatter
version: 1
project:
  id: 7204695b-7485-4989-863c-16cf6e4db155
  title: Jupyter Book 2 Workshop Template
  description: This description goes in the preface of the pdf output.
  # keywords: []
  authors:
    - name: Freek Pols
    - name: Luuk Fröling
    - name: Robert Lanzafame
    - name: Kirstie Whitaker
    - name: Jim Madge
  license:
    content: CC-BY-4.0
  references:
    myst-guide: https://mystmd.org/guide
    jupyter: https://docs.jupyter.org/en/latest

  date: 2025-11-02 # ${BUILD_DATE}
  github: https://github.com/jupyter-book/workshop-template # Change this URL to your GitHub repository
  edit_url:

  plugins:
    - https://github.com/TUD-JB-Templates/JB2_plugins/releases/download/experiment/experiment.mjs
    - https://github.com/jupyter-book/myst-plugins/releases/download/page-last-updatedv1.1/page-last-updated.mjs

  # exports and downloads
  exports:
    - format: typst
      template: lapreprint-typst
      output: exports/book.pdf
      id: output-pdf

  # Jupyter Notebook configuration
  jupyter:
    binder:
      repo: https://github.com/executablebooks/thebe-binder-base

  toc:
    - file: index.md                      # the landing page
    - file: content/1_intro.md
    - file: content/2_cheat_sheet.md
    - file: content/lessons/your_turn.md          # dropdown menu
      children:
        - file: content/lessons/0_setup.md
        - file: content/lessons/1_firstedit.md
        - file: content/lessons/1_landingpage.md
        - file: content/lessons/2_nextstep.md
          children:
            - file: content/lessons/2a_plugins.md
        - file: content/lessons/reuse.md
        - file: content/lessons/executable.md
        - file: content/lessons/5_workflows.md
        - file: content/lessons/6_pdfoverview.md
          children:
            - file: content/lessons/6a_myst.md
            - file: content/lessons/6b_pdfgeneration.md
            - file: content/lessons/6c_pdfoutput.md
            # - file: content/lessons/6d_typsttemplate.md
        # - file: content/lessons/7_styling.md
        - file: content/lessons/8_init.md

    - file: content/advanced_start.md
    - file: content/software.md
    - file: content/gallery.md
    # - file: content/example.ipynb
  abbreviations:
    JB2: Jupyter Book 2
    CI/CD: Continuous Integration/Continuous Deployment
    GHA: GitHub Actions
    GH: GitHub
    IDE: Integrated Development Environment
    VSC: Visual Studio Code
    CLI: commmand line interface


site:
  template: book-theme
  options:
    favicon: ./content/figures/favicon.svg      # path to your favicon
    style: ./style/custom.css
    logo: ./content/figures/logo.svg            # path to your logo, shown top left at site
    folders: false
    hide_authors: true
  parts:
    footer: style/footer.md

  actions:
    - title: Feedback
      url: https://github.com/jupyter-book/workshop-template/issues