6 ms·
GitPitch – Markdown Presentations for Devs on GitHub and GitLab
- rorosaurus 9y agoI would love to see a version of this where you can deploy your slideshow to your own Github Pages, with no external dependency on GitPitch.com.
- mankash666 9y agoReveal-md
- gitpitch 9y agoHi @rorosaurus please see my reply on this thread where I explain that any GitPitch presentation can be downloaded as a fully self-contained bundle (HTML/CSS/JS) with just one click. And that gives you exactly what you need to deploy your presentation wherever you like.
- SixBitProxyWax 9y agoThis is built on reveal.js. You can create a simple Jekyll template which will convert your markdown to a reveal.js presentation. I write all of my course slides in markdown and they get published on commit with no external services.
- mankash666 9y agoReveal-Md is similar: https://github.com/webpro/reveal-md https://github.com/webpro/reveal-md The pitch for git pitch itself appears directed at developers, who apparently have the time and patience to write markdown code for slideshows, but don't have the patience to output html/js via something like reveal-md. The drawback is the inherent advertising of gitpitch. With reveal-md your slideshow can be uploaded as a static page(s) to your own domain, or even directly to GitHub pages.
- MaxLeiter 9y agoCan the topic be changed to include BitBucket like the README does?
- gitpitch 9y agoHi @MaxLeiter I tried to include BitBucket in the title text but was limited to 80 characters so it simply did not fit. Apologies for the omission here but it was beyond my control.
- xkr 9y agoSecond slide of their hello-world example: <!-- .slide: data-autoslide="2000" --> ### No more <span style="color: #666666">Keynote.</span> ### <span class="fragment" data-fragment-index="1" data-autoslide="2000">No more <span style="color: #666666">Powerpoint.</span> <br> ### <span class="fragment" data-fragment-index="2" data-autoslide="3500">Just <span style="color: #e49436">Markdown</span>. Then <span style="color: #e49436">Git-Commit</span>.</li> Doesn't look like a simple markdown for me.
- gitpitch 9y agoHi @xkr fair point. But to be clear, the hello-world example was written specifically to be embedded in the gitpitch.com website and it was designed to auto-play every slide so it could be watched almost like a short movie. Typical presentations are something that the presenter manually steps through slide by slide as they speak. So needs none of fragment timing snippets you came across. Almost any other GitPitch presentation out there is a better example of what's typically involved, for example, see this presentation from AnyCable: https://gitpitch.com/anycable/anycable https://gitpitch.com/anycable/anycable
- ephimetheus 9y agoBut it still has all the <span>s for changing the color. That's not specific to gitpitch, but that takes away a lot from markdown I think. Once you start doing that, you can just write HTML to begin with..
- fenomas 9y agoThe whole point of markdown is that it covers a very small subset of HTML in a human-readable way, and for any formatting beyond that subset you use regular HTML. Adding <span> tags to customize things is very much the intended way to write markdown.
- harterrt 9y agoRight, but maybe markdown isn't the right markup language for presentations. This may be the correct way to add color in markdown, but it feels unnatural for the tool. I'm glad xkr brought this up it; it feels like hidden complexity.
- willtim 9y agoI've been doing this for years using pandoc and beamer.
- gitpitch 9y agoHi @mankash666, thanks for your feedback. GitPitch was indeed launched with developers in mind. Devs often need to present and promote their work. Having worked as a software consultant for over 20 years I can attest to this. And with the rising popularity of tech meetups and conferences now more than ever making it easy to clearly present concepts, designs, etc. right alongside the actual code in your repo is a big win. GitPitch is also seeing wide adoption across academia, particularly as a tool for delivering course materials, again right alongside the code. As a final note, you mentioned a perceived drawback. GitPitch presentations are indeed automatically made available online just as soon as you git-commit and push to GitHub, GitLab or Bitbucket. But if you really want to host the presentation on your own domain or under your GitHub pages a fully self-contained bundle for your presentation is available for download with one click. You can then take the contents of that bundle (HTML/CSS/JS) and deploy it on your own Web server. No problem.
- mankash666 9y agoThank you for the detailed response
- tsumnia 9y ago> GitPitch is also seeing wide adoption across academia, particularly as a tool for delivering course materials, again right alongside the code. Okay, you peaked my interest. This is the slide (built via PowerPoint) that I use to explain a nested loop structure to CS1 students [1]. Explain to me, as an academic mind you, how I can recreate this without learning CSS animations / JS magic? If I have to, that's fine, but all I'm asking is to make a circular motion animation. I'm demonstrating I can do that in 6 steps with PP; if technical knowledge is necessary, then it's a bit of a lie to say it can be widely adopted to academia. [1] https://gfycat.com/UnselfishAcclaimedJellyfish https://gfycat.com/UnselfishAcclaimedJellyfish
- gitpitch 9y agoHi @tsumnia you can't use GitPitch to create animated graphics. There are lots of other tools for that. However you can use animated gifs within a GitPitch presentation, read about background images on the Image Slides page in the Wiki: https://github.com/gitpitch/gitpitch/wiki/Image-Slides https://github.com/gitpitch/gitpitch/wiki/Image-Slides Or if you have a series of images that combined present some kind of animation or workflow you can use those images as an animation sequence as described by Image Animation in the Wiki: https://github.com/gitpitch/gitpitch/wiki/Image-Animations-Workflows https://github.com/gitpitch/gitpitch/wiki/Image-Animations-W... Here is a link to a sample presentation that makes use of this feature: https://gitpitch.com/gitpitch/microservices-architecture https://gitpitch.com/gitpitch/microservices-architecture Do keep in mind, GitPitch is not trying to offer everything PowerPoint is capable of. Far from it. But it is trying to offer just enough, in a lot of use cases. But perhaps not yours.
- orschiro 9y agoIt would be cool to also "pitch" Github Gists. :-)
- Romanulus 9y agoMarketing instincts came through; Gitch is waaaay to close to ginch.
- rwah 9y agoGetPeach
- andrewguenther 9y agoPlease, please, don't mess with my page history. When I hit back in my browser, I don't want to go back a slide, I want to go back to the previous page.
- gitpitch 9y agoHi @andrewguenther individual slides appear in the history by default as it allows direct linking inside a slideshow. See Slide Direct Links in the Wiki: https://github.com/gitpitch/gitpitch/wiki/Slide-Direct-Links https://github.com/gitpitch/gitpitch/wiki/Slide-Direct-Links If you want to disable this feature you can disable it using your PITCHME.yaml config file, just add: history: false
- redonkulus 9y agoYou could use replaceState instead to change the URL but leave the history intact. https://developer.mozilla.org/en-US/docs/Web/API/History_API#The_replaceState()_method https://developer.mozilla.org/en-US/docs/Web/API/History_API... This avoids having to click back through each slide.
- LeicaLatte 9y agoVery nice.
- jduckles 9y agoCicero http://cicero.xyz/ http://cicero.xyz/ does this using reveal.js
- stephenr 9y agoMaybe it's the mercurial-using cynic in me, but this seems vary barely related to Git, and much more related to Markdown.
- rwah 9y agoIt's related to Git because of GitHub and the fact that it does not work without GitHub. They should've called it GitHubPitchesPowerPoint. Git is a magic word and GitHub knows it. Spell 'git' to summon professionals of all kinds. But by releasing GitPeach, GitHub wants to show that its average 'dev' user needs help with making presentations. Is that really a problem? Presentations? Thanks, I don't need GitHub for presentations. What's next? GitCodesForYou? LetGitThink?
- stephenr 9y agoIs this a joke, AI gone wrong, or do you really not understand what's being discussed here? > it does not work without GitHub Firstly - it currently works with GitHub, GitLab and BitBucket. Secondly - it reads one markdown file from the repo. It could work from any url if they wanted it to. > But by releasing GitPeach, GitHub wants to show Let's assume thats some kind of weird autocorrect, and you meant GitPitch. Either way, GitHub isn't releasing anything here. It's a third party, who use GitHub to host the source code for the tool.
- rwah 9y agoI don't need anything 'git' or 'bucket' to make or publish presentations.
- didibus 9y agoI highly recommend pandoc for this use case. Pandoc is amazing. I recommend it for all your markup. To write tech docs, books, presentations, blog posts, etc. It lets you use Markdown to generate Html, Docx, Pdf, every other markup, and off course Presentations just like gitpitch. http://pandoc.org http://pandoc.org It can also easily be extended to support more features.
- radix07 9y agoInteresting, did not realize that was possible! Had to dig into pandoc a bit to find much information about presentations however as I have never actually read the manual to use it. Reference I found was page 60 of the pdf manual: https://pandoc.org/MANUAL.pdf https://pandoc.org/MANUAL.pdf
- andreineculau 9y agoI have been doing this for years with remark. Works on any git service, because it only needs a url to a markdown file. See http://andreineculau.github.io/go-remark/?//andreineculau.github.io/go-remark/remarkjs.md http://andreineculau.github.io/go-remark/?//andreineculau.gi... Source: https://github.com/andreineculau/go-remark https://github.com/andreineculau/go-remark
- shurcooL 9y agoThis reminds me of the present tool [1] that the Go project created, which I like and use for my slides these days. Main reason, which it shares with GitPitch, is the simplicity. It works for my basic needs, and I don't want anything more heavyweight. For an example, see .slide source [2], and the presentation result [3]. [1] https://godoc.org/golang.org/x/tools/cmd/present https://godoc.org/golang.org/x/tools/cmd/present [2] https://github.com/golang/talks/blob/master/2012/chat.slide https://github.com/golang/talks/blob/master/2012/chat.slide [3] https://talks.godoc.org/github.com/golang/talks/2012/chat.slide https://talks.godoc.org/github.com/golang/talks/2012/chat.sl...
- autarch 9y agoThis is very cool. One thing that I wish the docs made clearer was that this is a wrapper around `reveal.js`, so if you're familiar with reveal, then learning this tool is just a little more effort.
- gitpitch 9y agoHi @autarch, thanks for the helpful feedback. I'll make some changes to the docs to make this clearer so existing users of reveal.js will immediately feel right at home. It's probably also worth noting that you don't need any knowledge of reveal.js to use GitPitch, just write some Markdown and then git-commit.
- gitpitch 9y agoShoutout to reveal.js added to GitPitch README and Wiki. Credit already exists on the GitPitch.com website.
- alihcevik 9y agoAwesome! But I can't use it if I need to make my slides public. Do you support private repositories?
- gitpitch 9y agoHi @alihcevik, GitPitch does not support private repos. However, if you want to keep your project code private but share the knowledge about your project using GitPitch then you can of course create a public repo just for your PITCHME.md presentation markdown.
- dang 9y agoWould you please not @reply people? HN has threaded comments; the usernames are right there. Repeating them is redundant and has the same cloying effect that it would on regular conversation. (I'm one of the mods here.)
- SixBitProxyWax 9y agoJust use GitHub pages and a Jekyll template to turn your markdown into a reveal.js presentation. Works fine with private repos.
- ubitakken 9y agoAdd a markdown file to your repo and get a presentation. Very nice!
- izacus 9y agoSince conferences usually have flaky and broken wifis, does it work well offline?
- gitpitch 9y agoHi @izacus it certainly does. The offline feature was designed for this very reason. With one click you get a fully self-contained bundle that downloads onto your computer. Just open it and follow the simple instructions given here in the Wiki: https://github.com/gitpitch/gitpitch/wiki/Slideshow-Offline https://github.com/gitpitch/gitpitch/wiki/Slideshow-Offline
- izacus 9y agoThat's great to hear, will try it out for my next talk :)
- sidcool 9y agoVery useful. Hope it is adopted as well ad README.md
- aamederen 9y agoWhy not use something like Google Slides and try to make it via md? If it is so important to be able to find the pitch of a github repo, just put the link in README.md.
- Jraf 9y agosomething like that ? https://github.com/googlesamples/md2googleslides https://github.com/googlesamples/md2googleslides
- geraldbauer 9y agoFYI: I've put together an alternative free (open source) presentation (slide show) static html generator from markdown called Slide Show (S9) - https://github.com/slideshow-templates https://github.com/slideshow-templates Includes themes for reveal.js, deck.js, bespoke.js, s5, s6, and more. See PS: Since last year all theme packs / templates are GitHub Pages/Jekyll-compatible. See a ready-to-fork multi-talk site sample here - https://github.com/henrythemes/jekyll-talks-theme https://github.com/henrythemes/jekyll-talks-theme PPS: I've used it for over 30+ talks in markdown, see some "real world" samples on GitHub - https://github.com/geraldb/talks https://github.com/geraldb/talks
- SixBitProxyWax 9y agoI pretty much get the same result without needing a third party service by using a single Jekyll template with GitHub pages. Running a couple lines in bash gets me latex formatted PDF handouts of my slides via pandoc.
- tajen 9y agoThe concept was invented years ago with Reveal.JS. What's wrong with it? http://lab.hakim.se/reveal-js http://lab.hakim.se/reveal-js
- gitpitch 9y agoGreat question. There is absolutely nothing wrong with reveal.js. In fact I like it so much I chose it as the underlying presentation rendering engine for GitPitch. When you view a GitPitch presentation it is rendered by the reveal.js library. GitPitch simply provides a new way of delivering presentations that are powered by reveal.js that works seamlessly directly within GitHub, GitLab, or Bitbucket. If you prefer to use the reveal.js library directly, or use their hosted service slides.com or any other of the great tools mentioned in this thread, then go right ahead. There is something for everyone. GitPitch offers it's own unique approach. And for some, that makes the most sense.
- rawland 9y agoOne more alternative: https://remarkjs.com https://remarkjs.com Code: https://github.com/gnab/remark https://github.com/gnab/remark Personally, I'm very fond of it, due to it's preview/note-showing feature which you will enjoy, after pressing C (clone) and P (presenter-mode) in the cloned window. As with many alternatives, it doesn't pollute your slides with any unwanted ads or external dependencies.
- Zekio 9y agoTried to go fullscreen in a presentations and it couldn't exit the fullscreen mode again, not a fan...
- kensai 9y agoPlease, don't take it for trolling or anything, but I was kind of blasted away by the color selection of the GitPitch name in its official page. Reminded me of a certain site right away!
- chiefalchemist 9y agoWhat I'm seeing here is a simple and easy way for presenting step by step instructions. Imagine, here's Product X (e.g., class) and he's how to use it (or at least get to know it in a very bite size way). Sweet.
- haspok 9y agoI'm afraid the organization logic is totally upside down. I would like to have all my "pitches" in a single repo, possibly modifying some of them slightly in branches - not one pitch per repo, or even worse, one pitch per branch (???). Having a default PITCHME.md is convenient, but not if it is the only possible way. What's wrong with adding a filepath after the branch in the url?
- gitpitch 9y agoIf you would like to have all of your "pitches" in a single repo you can absolute do that. As described in the Wiki: "Sometimes you may find yourself wanting to build a series of related presentations within a single branch. Collectively these presentations may share common assets such as images, backgrounds, and even custom CSS styling." For details see the following page in the GitPitch Wiki: https://github.com/gitpitch/gitpitch/wiki/Asset-Sharing https://github.com/gitpitch/gitpitch/wiki/Asset-Sharing You might also be interested in support for modular Markdown which allows you to share not just assets but Markdown snippets across multiple presentations. See here: https://github.com/gitpitch/gitpitch/wiki/Modular-Markdown https://github.com/gitpitch/gitpitch/wiki/Modular-Markdown
- FranckP 9y agoIf you need advanced features such as graphs and charts, you should have a look at https://www.neomobili.com/products/slidium-markdown-presentation/ https://www.neomobili.com/products/slidium-markdown-presenta... The question is : can we use gitpitch with it? Both seems to use reveal.js internaly
- gitpitch 9y agoThat looks very nice. Just fyi to anyone reading here it also worth mentioning that GitPitch has built-in support for graphs and charts powered by chartsjs.org. See the GitPitch wiki here for details: https://github.com/gitpitch/gitpitch/wiki/Chart-Slides https://github.com/gitpitch/gitpitch/wiki/Chart-Slides