---
title: "Creating Tutorials"
linkTitle: "Creating tutorials"
weight: 2
author: Angela I. Renton, updated by Michèle Masson-Trottier
aliases:
- /tutorials/tutorial-template
- /tutorials-examples/contribute/contribute-tutorials
tags: ["template", "documentation"]
description: >
  A brief guide for contributing new tutorials.
---
# Creating Tutorials

We welcome tutorials that walk users through using tools or workflows available in Neurodesk. These tutorials are valuable learning resources that support accessible, reproducible neuroimaging.

## Overview

Tutorials are written in Markdown and hosted in the <a href="https://github.com/neurodesk/neurodeskedu/tree/main/books/tutorials" target="_blank" rel="noopener">
  `neurodeskedu:tutorials`
</a> repository, where they appear as part of the documentation site.

---

## Getting Started

To contribute a new tutorial, follow the steps below:

### 1. Start from the template

Download the <a href="https://github.com/neurodesk/neurodeskedu/blob/main/.github/content-templates/tutorial-template.md" target="_blank" rel="noopener"> Markdown template
</a> file from GitHub and edit it locally with your own content. 


The template includes:

- A frontmatter block with `title`, `linkTitle`, `description`, and other metadata
- A placeholder author attribution block
- Section headings and content structure for a clear tutorial layout

### 2. Follow best practices

- Use clear, descriptive section headers
- Include step-by-step instructions with commands and screenshots
- Store images in the appropriate `/static/` folder and link them with full paths
- Write in plain Markdown, using Hugo formatting where needed

See existing [tutorials](/neurodeskedu/tutorials/) for reference. 

---
## Saving and Submitting

Follow the steps for <a href="https://neurodesk.org/developers/documentation/creating-website-content/" target="_blank" rel="noopener">
  contributing content to NeurodeskEDU
</a>

1. Place your completed `.md` file in the appropriate subfolder under:

   <a href="https://github.com/neurodesk/neurodeskedu/tree/main/books/tutorials" target="_blank" rel="noopener">
  `/books/tutorials/`
</a>

2. Store any images in a matching subfolder in `/static/tutorials/`

3. Open a pull request in the <a href="https://github.com/neurodesk/neurodesk.edu" target="_blank" rel="noopener">
  `neurodeskedu repository`
</a>

4. In your pull request, include:
   - A short summary of your tutorial
   - Your name and GitHub handle (if you'd like to be credited)

---

## Attribution

All tutorial contributors are acknowledged on the <a href="https://neurodesk.org/developers/contributors/" target="_blank" rel="noopener">
  Contributors page
</a>.  
To be listed, include your name and a short description in your pull request using <a href="https://github.com/neurodesk/neurodesk.github.io/blob/main/.github/content-templates/contributor-format.md" target="_blank" rel="noopener">
  this format
</a>.

---

## Need Help?

If you have questions or would like feedback before submitting:

- Open a <a href="https://github.com/neurodesk/neurodesk.github.io/discussions" target="_blank" rel="noopener">
  discussion
</a>

We appreciate your contribution to the Neurodesk community and reproducible science.