Tutorials

In this section you will find Getting started (tutorials) pages that are learning-oriented.

• Tutorials
• Getting Started
• Starting the documentation server

Templates

Basic tutorial

# {Tutorial title}

<!-- This is an optional element. Feel free to remove. -->
## Prerequisites

{describe goal to achieve}, provide the following:

- [ ] {requirement 1} ({example of data and format})
- [ ] ...

## {Goal}

Steps:

- [ ] [How-to {step}](/how-to/update-documentation)
- [ ] ...

<!-- This is an optional element. Feel free to remove. -->
## Appendix

### Reference

- [Reference 1](https://diataxis-template.readthedocs.io/en/latest/) ({optional: note for reader})
- ...

Tutorial with variations

# {Tutorial title}

=== "{Variation 1}"

    <!-- This is an optional element. Feel free to remove. -->
    ## Prerequisites

    {describe goal to achieve}, provide the following:

    - [ ] {requirement 1} ({example of data and format})
    - [ ] ...

    ## {Goal}

    Steps:

    - [ ] [How-to {step}](/how-to/update-documentation)
    - [ ] ...

=== "{Variation 2}"

    <!-- This is an optional element. Feel free to remove. -->
    ## Prerequisites

    {describe goal to achieve}, provide the following:

    - [ ] {requirement 1} ({example of data and format})
    - [ ] ...

    ## {Goal}

    Steps:

    - [ ] [How-to {step}](/how-to/update-documentation)
    - [ ] ...

<!-- This is an optional element. Feel free to remove. -->
## Appendix

### Reference

- [Reference 1](https://diataxis-template.readthedocs.io/en/latest/) ({optional: note for reader})
- ...

To use, copy markdown text into a new .md file