9.7 KiB
Markdown Presentations For Everyone on GitHub, GitLab, Bitbucket, GitBucket, Gitea, and Gogs.
WEBSITE: www.gitpitch.com | HOW-TO : GitPitch Wiki | TWITTER: @gitpitch
- What is GitPitch?
- What is GitPitch Pro?
- Is GitPitch for you?
- How does GitPitch work?
- Compelling Presentations
- Customizable Presentations
- Code-Ready Presentations
- Speaker-Ready Presentations
- Modular Presentations
- Social Presentations
- Presentations That Just Work
- An Open Source Project
What is GitPitch?
GitPitch is a markdown presentation service for everyone on Git. You can use it to promote, pitch or present absolutely anything using the tools you already know and love - Markdown + Git.
The service introduces a new convention for Git users, called PITCHME.md. The GitPitch server turns PITCHME.md markdown files found within any public or private repo into online and offline, interactive slideshows.
GitPitch is an open source project so you can fork, clone, and modify the source. You can find detailed build instructions here. You can also submit bug, feature and pull-requests on this repo. If you like this project please show your support with a GitHub star.
Your support is much appreciated. Cheers, David ❤️.
What is GitPitch Pro?
GitPitch Pro is the GitPitch service hosted on gitpitch.com.
GitPitch Pro offers a wide range of free and enhanced subscription features, including GitPitch Desktop for local development, live previews, and presenting directly on your Linux, Windows, or OSX desktop.
GitPitch Pro is also available as GitPitch Enterprise for on-premises deployment with seamless integration for GitHub Enterprise, GitLab, Bitbucket, GitBucket, Gitea, and Gogs servers.
GitPitch Enterprise is delivered using Docker, the worlds leading software containerization platform.
Is GitPitch for you?
If you ever find yourself needing to present a concept, design, library, framework, product, service, training materials, or educational course work:
- To colleagues, clients or customers
- At meetups or conferences
- At training events or teaching sessions
Then GitPitch is for you. Simply capture your ideas in Markdown and let GitPitch automatically turn those ideas into compelling, responsive, online and offline slideshow presentations.
How does GitPitch work?
GitPitch presentations are powered by the amazing reveal.js presentation framework. But with GitPitch there is nothing to download. Nothing to install. All you need is your favorite text editor. And an account on GitHub, GitLab, or Bitbucket. Or a self-hosted instance of GitHub Enterprise, GitLab CE, GitBucket, Gitea, or Gogs.
No more Keynote. No more PowerPoint. Just Markdown. Then git-commit and push on any branch within a public GitHub, GitLab, Bitbucket, GitBucket, Gitea, or Gogs repo.
GitPitch slideshow presentations are compelling
Each slideshow presentation is beautifully rendered, fully responsive, and highly interactive with a rich set of features including:
- Markdown slides
- Code and GIST slides
- Image and Video slides
- Math Notation and Chart slides
- Fragment slides
See the Kitchen Sink Slideshow Presentation for a live demonstration of GitPitch slideshow features.
GitPitch slideshow presentations are customizable
Choose between six distinct visual themes:
Or further customize the look and feel of your slideshow presentations using background images, your own logo and even custom css.
GitPitch slideshow presentations speak code fluently
Step-through static-code blocks or the complete source-code from any file in the repo, line-by-line or section-by-section, from directly within any slideshow presentation using code-presenting.
GitPitch slideshow presentations are speaker-ready
GitPitch supports a speaker notes window that can be opened for any GitPitch online or offline presentation. The speaker notes window shows the current slide, provides a preview of the upcoming slide, and also includes a timer that helps keep track of time once you launch the presentation.
GitPitch slideshow presentations are modular
Create and deliver content and course materials as a series of slideshow presentations using modular markdown and shared assets (css, images, etc.) in a single git repo.
GitPitch slideshow presentations are social
GitPitch slideshow presentations are designed for sharing. You can:
- View any GitPitch presentation at its public URL
- Promote any GitPitch presentation using a GitHub badge
- Embed any GitPitch presentation within a blog or website
- Share any GitPitch presentation on Twitter, LinkedIn, etc
- Print any GitPitch presentation as PDF document
- Download and present any GitPitch presentation offline
Support for these social features can be found in the presentation menus.
GitPitch slideshow presentations just work
GitPitch requires no sign-up. And no configuration. Just add PITCHME.md ;)
The GitPitch Wiki provides a detailed How-To that walks you through getting started, building, customizing, and sharing your GitPitch slideshow presentations.
GitPitch - An Open Source Project
The GitPitch server is a Play Framework 2.5.x Web application open-sourced under an MIT License. This means you can fork, clone, and modify the source and build and test the server on your local machine.
You can find detailed build instructions here. You can also submit bug, feature and pull-requests on this repo. If you like this project please show your support with a GitHub star. Much appreciated.
GitPitch has been designed to follow standard Play Framework conventions. In order to understand the layout of this project see the following article, Anatomy of a Play Application.
MIT License
Copyright (c) 2016 David Russell
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.