gitpitch/README.md

66 lines
3.5 KiB
Markdown
Raw Normal View History

2016-08-11 21:25:28 +08:00
[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/gitpitch/hello-world/master?t=white)
2016-08-11 21:25:28 +08:00
# Promote, Pitch, Or Present Your GitHub Projects
2016-08-11 21:25:28 +08:00
## What is GitPitch?
2016-08-11 21:25:28 +08:00
GitPitch is a service that turns **[PITCHME.md](https://gitpitch.com/#gitpitch-pitchme-markdown)** markdown into online, interactive slideshows. You can use it to promote, pitch or present anything, including your own GitHub projects.
2016-08-11 21:25:28 +08:00
Each slideshow presentation is made instantly available online just as soon as you git-commit and push **PITCHME.md** on any branch within a public GitHub repo.
2016-08-11 21:25:28 +08:00
![URL](images/gp-url.jpg)
2016-08-11 21:25:28 +08:00
## Is GitPitch for you?
2016-08-11 21:25:28 +08:00
If you ever find yourself needing to present a project, design, library, integration, framework, or solution:
2016-08-11 21:25:28 +08:00
- To colleagues, clients or customers
- Or at meetups or conferences
2016-08-11 21:25:28 +08:00
Then GitPitch is for you. Simply capture your ideas in Markdown and let GitPitch automatically turn those ideas into compelling, responsive, online slideshow presentations.
2016-08-11 21:25:28 +08:00
## How does GitPitch work?
2016-08-11 21:25:28 +08:00
![TERMINAL](images/gp-terminal.png)
2016-08-11 21:25:28 +08:00
No more Keynote. No more PowerPoint. Just Markdown. Then git-commit on any branch within a public GitHub repo.
## GitPitch slideshow presentations are compelling
![SLIDESHOW](http://res.cloudinary.com/gitpitch/image/upload/github-integration/gp-slideshow-theme-style.png)
Each slideshow presentation is beautifully rendered, fully responsive, and highly interactive with a rich set of features including:
- [Markdown](https://github.com/gitpitch/gitpitch/wiki/Slide-Markdown) slides
- [Code](https://github.com/gitpitch/gitpitch/wiki/Code-Slides) and [GIST](https://github.com/gitpitch/gitpitch/wiki/GIST-Slides) slides
- [Image](https://github.com/gitpitch/gitpitch/wiki/Image-Slides) and [Video](https://github.com/gitpitch/gitpitch/wiki/Video-Slides) slides
- [Math Notation](https://github.com/gitpitch/gitpitch/wiki/Math-Notation-Slides) slides
- [Fragment](https://github.com/gitpitch/gitpitch/wiki/Fragment-Slides) slides
## GitPitch slideshow presentations are customizable
2016-08-12 01:10:10 +08:00
Choose between six distinct visual themes:
![SLIDESHOW](http://res.cloudinary.com/gitpitch/image/upload/github-integration/gp-slideshow-night-style.png)
2016-08-11 21:25:28 +08:00
2016-08-12 01:10:10 +08:00
Or further [customize the look and feel](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Settings) of your slideshow presentations using background images and your own logo.
![SLIDESHOW](http://res.cloudinary.com/gitpitch/image/upload/github-integration/gp-slideshow-bg-style.png)
2016-08-11 21:25:28 +08:00
## GitPitch slideshow presentations are social
GitPitch slideshow presentations are designed for sharing. You can:
- View any GitPitch presentation at its public URL
- [Promote](https://github.com/gitpitch/gitpitch/wiki/Slideshow-GitHub-Badge) any GitPitch presentation using a GitHub badge
- [Embed](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Embedding) any GitPitch presentation within a blog or website
- [Share](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Sharing) any GitPitch presentation on Twitter, LinkedIn, etc
- [Print](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Printing) any GitPitch presentation as PDF document
- [Download and present](https://github.com/gitpitch/gitpitch/wiki/Slideshow-Offline) any GitPitch presentation offline
## GitPitch slideshow presentations just work
GitPitch requires no sign-up. And no configuration. Just add **PITCHME.md** ;)
2016-08-12 12:55:14 +08:00
The [GitPitch Wiki](https://github.com/gitpitch/gitpitch/wiki) provides a detailed `How-To` that walks you through getting started, building, customizing, and sharing your GitPitch slideshow presentations.