Skip to content

Custom Slide Delimiters

David Russell edited this page Aug 26, 2016 · 6 revisions

When creating the content for your slideshow presentation within a PITCHME.md markdown file you need to be able to distinguish between one slide and the next. This is achieved very simply using a GitPitch convention within Markdown that indicates the start of each new slide. See Slide Delimiters for a discussion of the default slide delimiters.

Sometimes you might want to use custom slide delimiters, for example, to use slide delimiters that match the delimiters used by your preferred Markdown editing tool.

The PITCHME.yaml configuration file supports a number of properties to let you set custom delimiters for horizontal and vertical slides. These properties are called horz-delim and vert-delim respectively.

For example, to set your horizontal and vertical delimiters to HHH and VVV respectively, add the following properties to your PITCHME.yaml file:

horz-delim : HHH
vert-delim : VVV

If these properties are set in your PITCHME.yaml file then these custom delimiters are used by the GitPitch server to parse and render your slideshow presentation.

In addition to these two properties there are two additional properties called horz-delim-regexp and vert-delim-regexp respectively. These properties are optional. They should be used wherever your chosen custom delimiters use special characters in the context of regular expressions.

For example, to set your horizontal and vertical delimiters to --- and +++ respectively add the following properties to your PITCHME.yaml file:

horz-delim : ---
vert-delim : +++
vert-delim-regexp : \+\+\+

In this example, the custom horizontal delimiter is using the - character which is not considered a special character so there is no need to use the horz-delim-regexp property. However, the custom vertical delimiter is using the + character which is a special character, so we must also use the vert-delim-regexp property.

Clone this wiki locally