gitpitch / gitpitch

Markdown Presentations for Tech Conferences, Training, Developer Advocates, and Educators.

March 1, 2021: Service on gitpitch.com has been shutdown permanently.

GitPitch 4.0

• Docs
• Twitter

About

• Watch the Introducing GitPitch 4.0 Video
• Visit the What's New in GitPitch 4.0 Guide
• Go directly to the GitPitch 4.0 Quickstart Guide

GitPitch 4.0 is the perfect slide deck solution for tech conferences, training, developer advocates, and educators. Available on MacOS, Linux, and Windows 10. Work and present offline. Export to PDF, PPTX, and HTML. Or git-push to share public, private and password-protected slide decks online.

• GitPitch is a markdown presentation tool for MacOS, Linux, and Windows 10.
• GitPitch Desktop lets you develop, preview, and present markdown presentations offline.
• Using modular markdown to deliver modular decks.
• Export your markdown presentations to PDF, PPTX, and HTML.
• And publish and share your markdown presentations online.
• To publish any deck just git-push to any repo on GitHub, GitLab, or Bitbucket.
• And share it as a public, private, or password-protected slide deck.

GitPitch Documentation

The official GitPitch docs are maintained in this repository under the docs directory. Pull-requests on this repo to fix or improve the documentation in any way are very welcome. You can view the documentation live at https://gitpitch.github.io/gitpitch.

GitPitch Product Repos

GitPitch began as an open-source project back in 2016. Since early 2017 I have been working full time developing a number of GitPitch products and services most of which are maintained in private repositories.

This repository is now used to maintain the official GitPitch docs. You can also use this repository to report issues and request features for all GitPitch products using GitHub issue tracking.

gitpitch's Issues

Footer Comments

Is there any way to add footers? I have to add a "proprietary" statement on each slide and I would like that to appear at the bottom. Is that possible? Can I set something up in the YAML or theme to do it? I tried adding an html block but the test just appears in the middle of the slide, right under the other content rather than at the bottom.

<div class="footer">
Proprietary
</div>

Along the same lines, is it possible to put in title bars? When headers are added they are centered in the slide. I would like to be able to add titles which show up at the top of the slide and are left aligned. This is less of an issue though as I can just change the formatting of my slides.

pdf math conversion error

Great project! Converting kitchen-sink example to pdf fails to render math example correctly.

Gitlab: Images missing in presentation for private repo

Despite gitpitch does a local checkout of the repository (including all assets), it tries to use images from the original location (even with a relative url) although they exist locally.

This fails for images that require a login.

So the links to the images need rewriting from e.g.
http://ip/user/class01/raw/development/assets/lab-sol-b.png
to
assets/lab-sol-b.png.

Exporting to pdf does not preserve LaTeX font

See for example the difference between the proper gitpitch rendering and the non math fonts of the corresponding pdf export.

• System Version: macOS 10.12.3 (16D32)
• Kernel Version: Darwin 16.4.0
• Tested browsers:
  • Chrome Version 56.0.2924.87 (64-bit)
  • Safari Version 10.0.3 (12602.4.8)
  • Firefox Version 51.0.1 (64 bits)

Allow video embed with a timestamp

On the 10th and 11th slides of this presentation, I have a link to a youtube video. Ideally, I would like that embed to start at a specific timestamp.

On the 10th slide, I have a link with the proper timestamp, but the video does not open properly due to issue #30.

On the 11th slide, the embed option is lovely. I noticed that YouTube does not generate embed codes with a start time. I do not know if this could be controlled in GitPitch.

When I attempted to set a video as a background video I was not able to pass a start time.

If one of these options is implemented, it would be good to note the solution on the wiki page.

Override link to repository in presentation

Use case:

I use a separate repo for my gh-pages site for http://markdownedit.com (mike-ward/mde-site). It's easier than switching branches and waiting for Git to resync.

theme-override not working?

For my repository, it appears that custom CSS is being entirely ignored.

I followed in the instructions in the Wiki to the letter, as far as I could tell.

Based on the rendered HTML, reproduced below, it looks like there are many opportunities for Javascript to change the style after it is included, so my best guess is that this is a bug.

<head>
    <meta charset="utf-8">
    <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport">
    <title>[ GitPitch ] hq6/Thesis_Proposal/master</title>
    <meta content="Markdown Presentation powered by GitPitch." name="description">
    <meta content="GitHub, GitLab, Bitbucket, Markdown, Slideshow, Presentation, Developers, PITCHME" name="keywords">
    <link rel="icon" href="https://d1z75bzl1vljy2.cloudfront.net/img/favicon.ico">
    <link href="https://d1z75bzl1vljy2.cloudfront.net/reveal.js/3.3.1/css/reveal.css" rel="stylesheet" type="text/css">
    <link href="https://d1z75bzl1vljy2.cloudfront.net/reveal.js/3.3.1/css/theme/white.css" rel="stylesheet" type="text/css">
    
    <link href="https://d1z75bzl1vljy2.cloudfront.net/highlight.js/9.6.0/hybrid.css" rel="stylesheet" type="text/css">
    <link href="https://d1z75bzl1vljy2.cloudfront.net/octicons/3.5.0/octicons.css" rel="stylesheet" type="text/css">
    <link href="https://d1z75bzl1vljy2.cloudfront.net/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css">
    <style>
        .reveal .speaker-notes {
            background-color: #2a76dd;
            opacity : 0.7;
        }
        .centered {
            display: flex;
            justify-content: center;
            align-items: center;
            font-size:1.3em;
            font-weight: bold;
        }
    </style>

    
    <style>
    h1, h2, h3, h4, h5 {
    text-transform: none;
}

    </style><script type="text/javascript" src="https://d1z75bzl1vljy2.cloudfront.net/reveal.js/3.3.1/plugin/markdown/marked.js"></script><script type="text/javascript" src="https://d1z75bzl1vljy2.cloudfront.net/reveal.js/3.3.1/plugin/markdown/markdown.js"></script><script type="text/javascript" src="https://d1z75bzl1vljy2.cloudfront.net/reveal.js/3.3.1/plugin/highlight/highlight.js"></script>

For code snippets, consider binding an event that will select all of the text within the code box

I have a presentation with lots of code samples that I will be copying and pasting into an IDE.

It would be cool if I could easily add the code blocks to my clipboard in presentation mode.

Perhaps this behavior could be bound to a focus, click, or double-click event on the pre element.

Custom logo div should have a "logo" class for custom styling

I'd like to specify "logo: my_project_logo.png" in my PITCHME.yaml, then be able to style the logo. Currently this is difficult because there's no id or class associated with the image.

I have a simple change building locally if you'd like me to push it somewhere.

Add history option to enable direct links to slides

There is a history flag for reveal.js that enables that every slide has its url like http://localhost:8080/pitchme.html#/1.

I'd like to see this in gitpitch, as well

Math formula are garbage rendered in PDF

None of math formula are rendered correctly when exported to PDF:

This can be at least reproduced in Google Chrome and Adobe Reader on Windows 10.

Question relating to Private Repos

Is it possible to use gitpitch on a private repository?

PITCHME.yaml documentation?

A PITCHME.yaml is referenced on the custom CSS wiki page but I can't find other references or documentation on it. Can you add some documentation about where this file is expected to be and what configuration can be put there?

I ran into this problem because the custom CSS I added didn't seem to work. I added this PITCHME.yaml to the root of the repository

theme-override : docs/css/PITCHME.css

And the CSS file at docs/css/PITCHME.css

a img {
    border: 0;
}

.reveal .slides {
    text-align: left;
}
.reveal .slides section>* {
    margin-left: 0;
    margin-right: 0;
}

Parametrized path to PITCHME.md

(this is a feature request)

It'd be nice to be able to pass a path to PITCHME.md so I can have multiple presentations within a single repo and branch. Example:

|-- talk-1
|   `-- PITCHME.md
|-- talk-2
|   `-- PITCHME.md
|-- talk-3
|   `-- PITCHME.md
`-- README.md

Any chance to see it in near future? Because right now it's the only significant lack that prevent me from using GitPitch.

Add Python 3 snippet to Slideshow Offline wiki page

• Wiki page: https://github.com/gitpitch/gitpitch/wiki/Slideshow-Offline
• Python 3 snippet: python3 -m http.server

Background images are not in offline export

See the offline export of http://gitpitch.com/jroper/microservices-architecture as an example.

Add support for HTML img tags directly in PITCHME.md.

RFE to support HTML <img> tags within online and offline presentations. Can be useful sometimes to have control over - customize image properties/styling using HTML tag rather than plain Markdown ![]() image syntax.

For example:

<img src="https://path/to/logo.svg" style="width: 30%; margin-top: 50px; border: none; background: none; box-shadow: none;" />

Exporting to *.pdf does not preserve Emojis

MCVE for bug: https://github.com/rogalski/gitpitch-bug-mcve
OS: Mac OS Sierra
Browsers:
Safari 10.0.3 (12602.4.8)
Chrome 56.0.2924.87 (64-bit)

Unable to print

Hi @gitpitch, I'm having trouble printing https://gitpitch.com/steverice/pagerduty-api-v2-deck. I end up with a 200 response with the right application/pdf type, but the browser just keeps loading the PDF without ever finishing.

I have to imagine that the request is timing out, given it is a larger presentation. I try to print with gitpitch running locally buy I get this error:

GitPitch Slideshow print service temporarily unavailable.

A quick look at the code suggests this just means there was a general error with the printing functionality, but I don't see anything of note in the /logs directory. Any tips on how to debug this? I'm thinking there's some config I could tweak in my local instance to increase the timeout, but I'm not sure where to get started.

GA token rendering in view template broken.

Rendering of the GA token in it's Twirl view template is broken, needs quotes.

Theme overrides stylesheet should not be HTML escaped

The theme overrides stylesheet is embedded directly inside the generated HTML page for the presentation. This is fine, except that it is HTML escaped. Content inside style tags should not be HTML escaped, escaping it means selectors like ul > li break.

Broken URL in documentation

On the Getting Started slide of the wiki, the link to the Hello World slideshow is broken. It looks like it's been renamed from https://gitpitch.com/gitpitch/hello-world to https://gitpitch.com/gitpitch/gitpitch

Git repo not found on GitHub

When I open https://gitpitch.com/onetabbeyond/opencpu-spark-executor#, it shows below issue. DO you have any ideas?

Handling background-size YAML option unsafe when PITCHME.yaml unspecified.

Support for the new background-size YAML option assumes yOpts is non-null which is not the case when PITCHME.yaml is unspecified. Must test for yOpts existence before use.

Presentations are not loading properly (Jan 13, 2017 9am PT)

PITCHME.md 404 is appearing as an error

---?include=relative/path/file.md for composable slideshows

along with #52 one can achieve reusable slides

Configuring gitpitch on ubuntu

Hi,
After configuring and starting the application, when i browse to my server http://localhost:9000, it gives me a messageBad Request, Host not allowed error. my application logs says ,successfully started and listening on /0:0:0:0:0:0:0:0:9000.

After making build, i have done following changes

1. Changed Secret Key
2. Made gitlab as my default and set the API key.

Both gitlab and gitpitch is running on same ubuntu machine

Am i missed any steps?

Image Not Rendered in PDF

I cannot get images to render when using the 'print' function on an internal instance of GitPitch.

I am running my own instance of GitPitch connected to an internal GitLab instance. Everything works well until I try to print / save-to-pdf. I have a single slide that contains an image ( png referenced by a local path to the related repository ). When I view the presentation through GitPitch, the image shows up as expected. When I try to print it to pdf, everything gets saved out except the image gets replaced by the question mark placeholder. The server does not indicate that anything encountered any issues. I have put the image both as an embedded image and used it as a logo through yaml and have encountered the problem in either case

Displaying images in GitPitch

Please, can somebody let me know how to display successfully images in gitPitch ? Take a look at this PITCHME.md https://gitpitch.com/koffisani/github-rep-for-iai/pitchme

Slides preview

(this is a feature request)

It'd be nice to have some sort of preview before committing GITPITCH.md. So far I have two thoughts:

• Online text editor where one can copy-paster GITPITCH.md content.
• Render GITPITCH.md from repo's pull request, where one can change its content with git push --force in order to have a good Git history in the end.

Slide content alignment types

Slides are currently centered.

Is there a way to get the classic:

slide title
----------
- item 1
- item 2

Again. look to jdan/cleaver for inspiration on how they do this.

Allow per-slide custom CSS?

Currently, if I want to have a custom style for all <h1> tags on a particular slide, I must use inline-HTML for all <h1> tags, such as the following.

<h1 style="text-transform:none;">This is one place where I want h1 without text-transforms.</h1>
<h1 style="text-transform:none;">This is another place where I want h1 without text-transforms.</h1>

I tried the following, but it appears to do nothing.

<style>
h1 {
text-transform:none;
}
</style>
#This is one place where I want h1 without text-transforms
#This is another place where I want h1 without text-transforms

Is there some other syntax that allows me to specify style in a general way?

If so, I'd love to know what it is.
If not, I'd like to make that a feature request.

I have seen this page but it appears to be changes across the entire slideshow rather than an individual slide.

https://gitpitch.com/user/repo/branch/file.md so i can have more slideshows in one repo

Input focus on presentation after opening it

The keyboard focus should be on the presentation so that it is no longer necessary to click into the presentation to be able to use the shortcuts.

Possible to link directly to a slide?

Is this currently possible? Would be very beneficial when referencing something specific but wanting to give others the broader context of a talk.
Thanks!

Support for GitLab Snippets

I see that GitHub gists are supported to add code to presentations. It would be nice to have support for GitLab Snippets, which are GitLab's version of gists. The snippets are associated with a project so it keeps things more organized.

How to set no border on images?

I'm not a fan of the black border around the images. Is there a way to disable it?

I'd like to do this especially for logos on a white background.

Reduce cache interval for print and offline bundles on features branches.

Currently printing and downloading offline bundles share a 20 minute cache interval on both master and feature branches. For dev purposes it would be more appropriate for short cache intervals on branches so slideshow authors can more quickly see their changes.

Should Arrow Keys Advance Slides Containing Transitions?

I have a presentation with several HSLIDES and VSLIDES.

I have also added bullet transitions to several of these slides.

I notice that the arrow keys always trigger the bullet transitions.

Would it make more sense for the arrow keys to always advance to the next/prev slide disregarding any active bullet transitions on a page?

External links in a presentation should open in a new tab

The first slide in this presentation has an external link.

In Firefox, Chrome, and Safari, if I click it, I see a bunch of icons in the slide viewer, but the link does not open.

In IE, I see an error message "This content cannot be displayed in a frame". If I click the link in the error dialog, a new tab opens.

Wondering if building own server (as per wiki), will this allow viewing private gitlab repos?

I have a use-case to present pitchme's from non-public repos on my self-hosted gitlab server ... is that possible to do with a local pitchme server install? Thanks for your great project.

Use Open Graph meta tags to enhance social sharing.

Allow social sharing sites such as LinkedIn, Facebook, Twitter, etc. detect and display Open Graph meta tags specific to individual GitPitch presentations.

Supports for charts

I really like your service and would like to see support for charts, for example by implementing
https://github.com/rajgoel/reveal.js-plugins.

Fullscreen option is not working in IE

I was testing a separate issue in multiple browsers and I noticed that the fullscreen "f" keyboard shortcut is not working in IE 11. It works fine in Chrome, Safari, and Firefox.

I am running IE 11.0.9... on Windows 7 Enterprise.

The other keyboard shortcuts seem to work in IE.

I see the following error in my IE Console when loading a presentation.

SCRIPT5007: Unable to get property 'style' of undefined or null reference
File: reveal.js, Line: 1, Column: 9353

Exporting to *.pdf does not preserve monospace font of code snippets

MCVE for bug: https://github.com/rogalski/gitpitch-bug-mcve
OS: Mac OS Sierra
Browsers:
Safari 10.0.3 (12602.4.8)
Chrome 56.0.2924.87 (64-bit)

Code blocks indentation is missing

Hi, first of all thank you very much for your work!

I'm trying to work on a slidedeck with numerous code block and just saw that code block indentation seems missing. I also checked the kitchen-sink demo and it also seems that code block indentation is missing: https://gitpitch.com/gitpitch/kitchen-sink/master.

Could it be a bug in highlight.js?

Allow embed of a user's Google Analytics Code into a Presentation

If possible, this would be really useful for tracking.

Ideas, Observations

Just started using this. Awesome idea. Couple of use issues.

• #HSLIDE/#VSLIDE are strange separators. It looks like a header in markdown previews. Suggest something more compact like -- for horizontal, ++ for vertical (see jdan/cleaver).
• Doesn't recognize setext headers.
• PITCHME.md file name is case sensitive.
• In general, you should be able to run a pitchme.md file through Pandoc (I use this to reformat markdown files) without destroying the slide show.

I use http://markdownedit.com to edit markdown. It has a handy reformat function (using Pandoc). However, it runs afoul of with some of the gitpitch conventions. (like #hslide, #vslide).

gitlab etc support not clearly documented and possible improvement

Given me/foo on gitlab with PITCHME.md and me/* on github fails to find project. The following works

https://gitpitch.com/user/project/branch?grs=gitlab

It appears you first check github. If you fail perhaps continue to gitlab etc. If me/foo on both gitlab and github perhaps this should be an error and force explicit call.

Failing server PDF export

This simple snippet crashes my gitpitch server when trying to create a pdf file:

Training: AOP


Session 0

#HSLIDE


Agenda for today


#HSLIDE


TOSCA & YAML


What is it used for in our context?

#VSLIDE


YAML intro


human-readable data serialization
tree of of elements based on whitespaces
implizit data types
every space counts (we use two-spaces indentation)


#VSLIDE

This is the error log:

2017-03-01 12:43:32,480 application-akka.actor.default-dispatcher-25 [debug] c.g.s.PitchService - cachedPDF: pdfAge=1488372212480, max=1200000, file=./tmp/gitpitch/swap/gitlab/*/class01/master/PITCHME.pdf
2017-03-01 12:43:32,487 Front-End-Pool [debug] c.g.s.PitchService - fetchPDF: pp=/gitlab/*/class01/master [ white, null ]
2017-03-01 12:43:32,487 Front-End-Pool [debug] c.g.s.PrintService - fetchPDF: pp=/gitlab/*/class01/master [ white, null ]
2017-03-01 12:43:32,491 Back-End-Pool [debug] c.g.s.PrintService - generatePDF: pp=/gitlab/*/class01/master [ white, null ]
Loading page http://172.16.2.215:9000/pitchme/slideshow/gitlab/*/class01/master?t=white&fragments=false ...
2017-03-01 12:43:33,171 application-akka.actor.default-dispatcher-25 [info] c.g.c.PitchController - slideshow: [ cached, printg ] /gitlab/*/class01/master [ white, null ]
2017-03-01 12:43:33,173 application-akka.actor.default-dispatcher-25 [debug] c.g.m.SlideshowModel - buildSlideDelim: pattern=#HSLIDE
2017-03-01 12:43:33,173 application-akka.actor.default-dispatcher-25 [debug] c.g.m.SlideshowModel - buildSlideDelim: pattern=#VSLIDE
+- TypeError: undefined is not an object (evaluating 'dom.controls.style')
|_ http://172.16.2.215:9000/assets/libs/reveal.js/3.4.1/js/reveal.js: 980 (in function "configure")
2017-03-01 12:43:33,261 application-akka.actor.default-dispatcher-25 [info] c.g.c.PitchController - markdown:  [ cached, online ] /gitlab/*/class01/master [ white, null ]
Loading page finished with status: success
Reveal JS DeckTape plugin activated
Printing slide #/2/2    (5/5) ...
Printed 5 slides
2017-03-01 12:43:38,417 Back-End-Pool [debug] c.g.s.ShellService - exec: op=pdf, pp=/gitlab/*/class01/master [ white, null ], time taken=5925
2017-03-01 12:43:38,418 Front-End-Pool [debug] c.g.s.PitchService - cachedPDF: pdfAge=1488372218417, max=1200000, file=./tmp/gitpitch/swap/gitlab/*/class01/master/PITCHME.pdf
2017-03-01 12:43:38,418 Front-End-Pool [debug] c.g.s.PitchService - fetchPDF: pp=/gitlab/*/class01/master [ white, null ], returning pdf=null
2017-03-01 12:43:38,418 Front-End-Pool [info] c.g.c.PitchController - print:     [ failed, printg ] /gitlab/*/class01/master [ white, null ]