Unlimited Slideshows



The PITCHME.md convention guarantees that any PITCHME.md markdown file found within any directory on any branch within your repository can be turned into a GitPitch slideshow presentation.

This guide explains how you can create, manage, and share an unlimited number of slideshow presentations within a single Git repository branch.


1. Working with the default Slideshow Presentation within a Branch

The PITCHME.md found in the root directory of any branch is known as the default slideshow presentation. The corresponding directory structure and files within a branch for the default slideshow presentation are as follows:

.
├── PITCHME.md
├── PITCHME.yaml

The PITCHME.yaml properties file is optional. When present, it can be used to activate custom settings for your slideshow presentation.

The default slideshow presentation is made available at the following URL:

SLIDESHOW-URL

Where you must substitute the corresponding Git account name, repository, and branch for $user, $repo, and $branch respectively.



2. Working with additional Slideshow Presentations within a Branch

There are no limits to the number of slideshow presentations you can create within a single branch in a Git repository.

All slideshow presentations found within a sub-directory below root within the branch are made available at the following URL:

SLIDESHOW-URL-CONFERENCE

The value of $directory must identify a directory path within the branch that contains a PITCHME.md markdown file.



3. Example: Conference Slideshow Presentation URL

Assuming a branch has the following directory structure and files:

.
├── PITCHME.md
├── PITCHME.yaml
│
├── conference
│   └── PITCHME.md

The Conference slideshow presentation URL is created as follows:

SLIDESHOW-URL-CONFERENCE



4. Example: New York Meetup Slideshow Presentation URL

Assuming a branch has the following directory structure and files:

.
├── PITCHME.md
├── PITCHME.yaml
│
├── conference
│   └── PITCHME.md
│
├── meetups
|   |
│   ├── newyork
│   │   ├── PITCHME.md
|   |
│   ├── berlin
│   │   ├── PITCHME.md
│   │   ├── PITCHME.yaml
|   |
│   ├── tokyo
│   │   ├── PITCHME.md
│   │   ├── PITCHME.yaml

The New York Meetup slideshow presentation URL is created as follows:

SLIDESHOW-URL-MEETUP


5. Slideshow Presentation Settings Policy

Custom slideshow settings can be activated for any slideshow presentation.

By default, GitPitch will look for a PITCHME.yaml file alongside the active PITCHME.md markdown file for any presentation.


Public Repository Settings Policy

If a PITCHME.yaml properties file is not found alongside the PITCHME.md, GitPitch will automatically attempt to use the PITCHME.yaml file in the root directory of the repository. If following this fallback procedure no settings file has been found, the presentation is simply rendered without the activation of custom settings.

This policy allows presentation authors to maintain a single PITCHME.yaml in the root directory and have those settings shared by many public presentations within a single branch.


Private Repository Settings Policy

If a PITCHME.yaml properties file is not found alongside the active PITCHME.md, all attempts at rendering the slideshow presentation are halted.

This policy forces presentation authors to be explicit about custom settings - including slideshow visibility settings - for each individual private presentation.