> For the complete documentation index, see [llms.txt](https://ibm-developer.gitbook.io/workshop-template/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ibm-developer.gitbook.io/workshop-template/readme.md).

# Advocacy Workshop

This is a template for workshops hosted on GitHub Pages using Material for MkDocs. To view it online, go to:

<https://ibm.github.io/repo-name>

Create a new repo based off this template, and use the following folders as a guide:

```
- data (any data (CSV, JSON, etc files) to be used)
- docs (this is where the workshop is documented)
|_ <folder-n> (these are exercises for the workshop)
  |_README.md (the steps for the exercise, in Markdown)
|_ README.md (this will appear on the gitbook home page)
- notebooks (any Jupyter notebooks can go here)
- src (any application source code can go here)
.mkdocs.yaml (configuration for mkdocs)
.travis.yaml (runs markdownlint by default)
README.md (only used for GitHub.com)
```

## Tips and conventions

### Screenshots

Screenshots look better if they are full page. Use [ImageMagick](https://imagemagick.org) to create a nice border around images with this command:

```bash
magick mogrify -bordercolor gray -border 2
```