From 2e8d7fe08e4989d4442f8093f8a67fa9b0b4eeb1 Mon Sep 17 00:00:00 2001 From: gitpitch Date: Tue, 13 Oct 2020 12:54:25 +0100 Subject: [PATCH] Desktop HTML Export doc preview and deploy. - Update Cloud URL doc for branches named master conventions. --- README.md | 2 +- docs/cloud/password-protected-slide-decks.md | 32 ++++----- docs/cloud/private-slide-decks.md | 32 ++++----- docs/cloud/public-slide-decks.md | 32 ++++----- docs/desktop/publishing.md | 68 ++++++++++++++++++++ 5 files changed, 120 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 85cc2c1..aade6a3 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ GitPitch 4.0 is the perfect slide deck solution for tech conferences, training, - 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...perfect for training and course content. -- Export your markdown presentations to PDF, PowerPoint PPTX, and HTML. +- Export your markdown presentations to PDF, PPTX, and HTML. - And publish and share your markdown presentations online at [gitpitch.com](https://gitpitch.com). - 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 on [gitpitch.com](https://gitpitch.com). diff --git a/docs/cloud/password-protected-slide-decks.md b/docs/cloud/password-protected-slide-decks.md index c263c11..14f4534 100644 --- a/docs/cloud/password-protected-slide-decks.md +++ b/docs/cloud/password-protected-slide-decks.md @@ -46,21 +46,23 @@ Password-protected token management is as simple as adding and removing tokens o The following snippets demonstrate the basic structure of confidential slide deck URLs on **gitpitch.com**. Decks can be uniquely identified using PITCHME.md paths, branch names, tag names, and commit ids. +?> If the files for your slide deck are maintained within a branch named **master** you can omit the branch name from the URL for your slide deck. All other branches require the branch name to be specified on the URL. + #### ** GitHub Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?p=coding/intro # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. @@ -73,16 +75,16 @@ https://gitpitch.com/acmecorp/tech-talk/commitX?p=coding/intro #### ** GitLab Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master?grs=gitlab +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk?grs=gitlab -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main?grs=gitlab -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev?grs=gitlab -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?grs=gitlab&p=coding/intro # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. @@ -95,16 +97,16 @@ https://gitpitch.com/acmecorp/tech-talk/commitX?grs=gitlab&p=coding/intro #### ** Bitbucket Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master?grs=bitbucket&s=sneakpEEk +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk?grs=bitbucket&s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main?grs=bitbucket&s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev?grs=bitbucket&s=sneakpEEk -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?grs=bitbucket&p=coding/intro # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. diff --git a/docs/cloud/private-slide-decks.md b/docs/cloud/private-slide-decks.md index a7b86c4..071a453 100644 --- a/docs/cloud/private-slide-decks.md +++ b/docs/cloud/private-slide-decks.md @@ -44,21 +44,23 @@ Once activated, `git-push` your presentation files on any branch. A valid token The following snippets demonstrate the basic structure of private slide deck URLs on **gitpitch.com**. Decks can be uniquely identified using PITCHME.md paths, branch names, tag names, and commit ids. +?> If the files for your slide deck are maintained within a branch named **master** you can omit the branch name from the URL for your slide deck. All other branches require the branch name to be specified on the URL. + #### ** GitHub Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master?s=sneakpEEk +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk?s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main?s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev?s=sneakpEEk -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?p=coding/intro&s=091827 # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. @@ -71,16 +73,16 @@ https://gitpitch.com/acmecorp/tech-talk/commitX?p=coding/intro&s=091827 #### ** GitLab Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master?grs=gitlab&s=sneakpEEk +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk?grs=gitlab&s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main?grs=gitlab&s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev?grs=gitlab&s=sneakpEEk -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?grs=gitlab&p=coding/intro&s=091827 # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. @@ -93,16 +95,16 @@ https://gitpitch.com/acmecorp/tech-talk/commitX?grs=gitlab&p=coding/intro&s=0918 #### ** Bitbucket Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master?grs=bitbucket&s=sneakpEEk +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk?grs=bitbucket&s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main?grs=bitbucket&s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev?grs=bitbucket&s=sneakpEEk -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?grs=bitbucket&p=coding/intro&s=091827 # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. diff --git a/docs/cloud/public-slide-decks.md b/docs/cloud/public-slide-decks.md index 2f86516..d8a0fa6 100644 --- a/docs/cloud/public-slide-decks.md +++ b/docs/cloud/public-slide-decks.md @@ -34,21 +34,23 @@ Once activated `git-push` your presentation files on any branch and immediately The following snippets demonstrate the basic structure of public slide deck URLs on **gitpitch.com**. Decks can be uniquely identified using PITCHME.md paths, branch names, tag names, and commit ids. +?> If the files for your slide deck are maintained within a branch named **master** you can omit the branch name from the URL for your slide deck. All other branches require the branch name to be specified on the URL. + #### ** GitHub Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?p=coding/intro # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. @@ -61,16 +63,16 @@ https://gitpitch.com/acmecorp/tech-talk/commitX?p=coding/intro #### ** GitLab Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master?grs=gitlab +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk?grs=gitlab -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main?grs=gitlab -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev?grs=gitlab -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?grs=gitlab&p=coding/intro # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. @@ -83,16 +85,16 @@ https://gitpitch.com/acmecorp/tech-talk/commitX?grs=gitlab&p=coding/intro #### ** Bitbucket Deck** ```bash -# The default slide deck in the acmecorp/tech-talk repo, master branch. -https://gitpitch.com/acmecorp/tech-talk/master?grs=bitbucket&s=sneakpEEk +# The default slide deck in the acmecorp/tech-talk repo, branch named "master". +https://gitpitch.com/acmecorp/tech-talk?grs=bitbucket&s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, main branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "main". https://gitpitch.com/acmecorp/tech-talk/main?grs=bitbucket&s=sneakpEEk -# The default slide deck in the acmecorp/tech-talk repo, dev branch. +# The default slide deck in the acmecorp/tech-talk repo, branch named "dev". https://gitpitch.com/acmecorp/tech-talk/dev?grs=bitbucket&s=sneakpEEk -# The coding/intro slide deck in the acmecorp/tech-talk repo, master branch. +# The coding/intro slide deck in the acmecorp/tech-talk repo, branch named "master". https://gitpitch.com/acmecorp/tech-talk/master?grs=bitbucket&p=coding/intro # The coding/intro slide deck in the acmecorp/tech-talk repo, at tagX. diff --git a/docs/desktop/publishing.md b/docs/desktop/publishing.md index 26ae9f0..74f244c 100644 --- a/docs/desktop/publishing.md +++ b/docs/desktop/publishing.md @@ -10,6 +10,74 @@ Using the desktop app you can export any slide deck with just one click: PDF is a highly portable document format that is great for sharing or printing any slide deck. PPTX slides can be viewed in Microsoft PowerPoint, LibreOffice, Apple Keynote, and Google Slides. While your HTML slides can be published by copying the exported files under your own website or [GitHub Pages](https://pages.github.com/). +### Preview HTML + +If you want to preview your HTML slide deck locally before [deploying](#deploy-html) to your own server or GitHub Pages you can take the following steps: + +1. Generate a HTML slide deck using GitPitch Dekstop +1. Create a new directory on your local file system, for example, `/home/david/tecktalk` +1. Move the generated `PITCHME.zip` file into your new local directory +1. Unzip the generated `PITCHME.zip` file in your new local diretory +1. You will now see an `index.html` file plus some additional file dependencies. +1. Delete the generated `PITCHME.zip` file from your new local directory + +After you have completed these steps you need to start a local web server within your new local directory so you can open and preview your slide deck. The following tabs demonstrate some simple ways to launch a local web server: + + + +#### ** Python 2 ** + +```bash +# Assuming Python 2 is installed locally, run this command +# in the new local directory where your HTML slides are found. + +python -m SimpleHTTPServer + +# What version of Python are you running locally? +python -V +``` + +#### ** Python 3 ** + +```bash +# Assuming Python 3 is installed locally, run this command +# in the new local directory where your HTML slides are found. + +python -m http.server + +# What version of Python are you running locally? +python -V +``` + +#### ** Node.js ** + +```bash +# Assuming http-server is installed globally, run this command +# in the new local directory where your HTML slides are found. + +http-server + +# How do I install the http-server package globally? +npm install --global http-server +``` + + + + +### Deploy HTML + +When exporting a slide deck as HTML a file called `PITCHME.zip` is generated by GitPitch Desktop. The desktop app provides a one-click download of this file directly in your browser. To deploy the slide deck contained within that ` PITCHME.zip` file under your own website or GitHub Pages you need to take the following steps: + +1. Generate a HTML slide deck using GitPitch Dekstop +1. Copy the generated `PITCHME.zip` file onto your server +1. Create a new directory under your web server, for example, `/www/tecktalk` +1. Move the generated `PITCHME.zip` file into your new web server directory +1. Unzip the generated `PITCHME.zip` file in your new web server diretory +1. You will now see an `index.html` file plus some additional file dependencies. +1. Delete the generated `PITCHME.zip` file from your new web server directory + +Your HTML slide deck should then be available at `https://yorserver.com/techtalk`. + ### Settings The set of `print` settings let you customize PDF and PPTX output when exporting GitPitch slide decks.