Template Basics



The Template itself is a regular GitPitch slideshow presentation. Albeit using sample markdown content and images, plus template-specific CSS styling.

This guide draws your attention to some high-level design features of the template:

Understanding these features will help you to get the most out of the template.


The Template Anatomy

The following directory listing provides a high level overview of the basic file strucutre used by the template:

.
├── PITCHME.md
├── PITCHME.yaml
└── template
    ├── css
    │   └── PITCHME.css
    ├── img
    │   ├── batman.png
    │   ├── dataflow.png
    │   ├── developer.jpg
    │   ├── einstein.png
    │   └── ....
    └── md
        ├── about/PITCHME.md
        ├── announcement/PITCHME.md
        ├── code-presenting/PITCHME.md
        ├── header-footer/PITCHME.md
        ├── image/PITCHME.md
        ├── list-content/PITCHME.md
        ├── quotation/PITCHME.md
        ├── sidebar/PITCHME.md
        ├── sidebox/PITCHME.md
        ├── split-screen/PITCHME.md
        └── wrap-up/PITCHME.md

If you have already developed GitPitch slideshow presentations then this file and directory structure should look quite familiar. Perhaps the most notable divergence from most regular presentations is the use of a template directory at the top-level of the hierarchy.

By convention, this directory is typically named assets for most GitPitch presentations.

However, the template namespace has been used here in order to minimize the likelihood of a collision between the template and the files already in the repository when the template files are copied over.


The Template Modular Markdown

The following directory listing focuses on the files that contain the markdown for each of the slide designs used by this template.

.
├── PITCHME.md
└── template
    └── md
        ├── about/PITCHME.md
        ├── announcement/PITCHME.md
        ├── code-presenting/PITCHME.md
        ├── header-footer/PITCHME.md
        ├── image/PITCHME.md
        ├── list-content/PITCHME.md
        ├── quotation/PITCHME.md
        ├── sidebar/PITCHME.md
        ├── sidebox/PITCHME.md
        ├── split-screen/PITCHME.md
        └── wrap-up/PITCHME.md

Related slides are grouped and maintained within distinct, design-specific PITCHME.md markdown files. For example, all sidebar slide designs within this template are maintained within the following file:

template/md/sidebar/PITCHME.md

Taking advantage of GitPitch support for modular markdown, the content of these design-specific files is automatically woven into the main PITCHME.md file when rendering the template as a complete slideshow presentation.

Using design-specific PITCHME.md files also allows us to render each individual design-specific file as it’s own self-contained slideshow. See the Template Slide Designs guide for an example of how we do that.

This modular approach helps presentation authors in a number of ways. Most importantly, it simplifies the lookup for markdown snippets associated with individual slide designs. The lookup is simplified as each design-specific file is relatively small so easy to search and browse.


The Template Custom Styling

The following directory listing focuses on the files used to define and activate the custom CSS styles used to deliver the template slide designs:

.
├── PITCHME.yaml
└── template
    └── css
         └── PITCHME.css

The template-specific CSS style rules are defined in the following file:

template/css/PITCHME.css

These CSS style rules are activated using the theme-override property in the PITCHME.yaml settings file used by the template. You can learn more about the theme-override setting here.

As a presentation author, you can decide to stick with the default CSS style rules for the template. Or you can customize any aspect of your slideshow by modifying or creating new style rules to more accurately reflect your brand. See the Template Mastery guide for further details.


The Template Custom Settings

The default slideshow settings defined by the template are found in the following file:

.
└── PITCHME.yaml

You can customize these settings as needed, for example, to activate your own custom logo and footnote to be displayed on every slide.