GitPitch Documentation

repository·master·Indexed 26 days ago

https://github.com/gitpitch/gitpitch

A markdown-based presentation tool for developers to create, preview, and present slide decks. It features GitPitch Desktop for offline development and exporting (PDF, PPTX, HTML), GitPitch Cloud for online publishing via GitHub, GitLab, or Bitbucket, and GitPitch CICD for automated slide generation. The tool supports grid layouts, modular markdown widgets for code, Gists, and diagrams, and specialized speaker support features.

Tokens
52.8K
Snippets
195
Records
381
Agent score
90%

What's inside GitPitch

  1. Overview of GitPitch Enterprise

    master

    GitPitch Enterprise provides an on-premises deployment solution that includes the functionality of the gitpitch.com server and the GitPitch desktop app. It is designed for organizations requiring high privacy and control over their Git infrastructure.

    Key capabilities:

    • On-premises deployment of server functionality.
    • Publishing slideshow presentations from within both public and private repositories managed by a self-hosted Git server.

    Limitations:

    • Password-Protected Publishing (a feature available on gitpitch.com) is not supported by GitPitch Enterprise.
  2. Overview of GitPitch 4.0

    master

    GitPitch 4.0 is a markdown-based presentation tool designed for tech conferences, training, and developer advocacy. It allows users to develop, preview, and present slide decks offline using GitPitch Desktop.

    Key features include:

    • Cross-platform support: Available on MacOS, Linux, and Windows 10.
    • Modular Markdown: Use modular markdown to create and deliver modular decks.
    • Export options: Export presentations to PDF, PPTX, and HTML.
    • Online Publishing: Publish and share decks (public, private, or password-protected) by performing a git-push to any repository on GitHub, GitLab, or Bitbucket.
  3. Overview of GitPitch CICD

    master
    GitPitch CICD is a continuous integration executor designed to be integrated into existing CI/CD pipelines. It automatically generates PDF, PPTX, and/or JPG screenshots of slide decks located within any Git repository. It can be triggered by standard CI/CD events such as commits, tags, or releases on specific target branches and repositories.
  4. Utilize Grid Layouts and Synchronized Stacks

    master

    GitPitch 4.0 uses a grid layout system to provide pixel-perfect control over the positioning and sizing of slide content within Markdown.

    Key capabilities include:

    • Drag-and-drop precision: Replicates traditional layout tools directly within Markdown.
    • Synchronized Stacks: Synchronizes slide content across both stack and list content, supporting rich elements like code, diagrams, videos, and math formulas.
    • Grid Fit: Automatically fits content within the grid.
    • Animations: Supports grid-based animations.
  5. Generate slide screenshots with GitPitch CI/CD

    master
    GitPitch CI/CD can be integrated into existing CI/CD pipelines to automatically generate GitPitch PDF, PPTX, and JPG slide screenshots. These jobs can be triggered by events such as a commit, tag, or release on target branches and repositories.
  6. Install and use GitPitch Desktop

    master

    GitPitch Desktop is a markdown presentation tool delivered via Docker Desktop. It is available for MacOS, Linux, and Windows 10.

    Key capabilities include:

    • Offline Slide Deck Development: Create slide decks using standard markdown and widget syntax with automatic live previews in the browser. You can use the embedded markdown editor or your own IDE.
    • Offline Presenting: Present slide decks locally. Press the S key while viewing a slide deck to launch the speaker window.
    • Offline Publishing: Export slide decks as PDF, PPTX, or self-contained HTML bundles.
    • Online Publishing: Publish slide decks to GitHub, GitLab, or Bitbucket via a git push to sync with the GitPitch Cloud Service.
  7. Configure GitPitch Cloud publishing options

    master

    GitPitch Cloud supports several publishing modes depending on your repository type and desired access control. You can configure these using settings in your PITCHME.yaml file:

    • Public Slide Decks: Using either public or private repositories.
    • Private Slide Decks: Using private repositories.
    • Password-protected Slide Decks: Using private repositories.
    • Audio Slide Decks: Specialized publishing for decks with audio.
    • Survey Slide Decks: Specialized publishing for decks with survey features.
  8. Migrate legacy 3.0 slide decks to GitPitch 4.0

    master

    GitPitch 4.0 uses a new Grid Layouts system and is no longer compatible with the deprecated Snap Layouts syntax. To ensure your slide decks continue to render and are compatible with the GitPitch desktop app, you should migrate your markdown to the 4.0 grid layouts syntax.

    Note on End-of-Life: Legacy 3.0 slide decks using snap layouts published on gitpitch.com were scheduled for removal after June 30, 2021. To avoid loss of service, update your markdown to the 4.0 grid layouts syntax.

  9. Align mismatched list and stack items using @ghost

    master

    Synchronization in GitPitch matches content by position across fragment-aware elements. If a list has more items than a stack, the items will not align as expected (e.g., List Item B might incorrectly synchronize with Stack Item C).

    To fix positional misalignment, insert an @ghost widget into the stack at the specific position where a list item should appear without a corresponding stack element. This acts as an empty element to maintain the correct index for subsequent items.

    @ul[list-spaced-lg-bullets, drag=50 100, drop=left, fit=2, sync=true]
    - List Item A
    - List Item B
    - List Item C
    @ul
    
    [drag=50 100, drop=right, flow=stack, sync=true]
    ## Stack Item A
    @ghost
    ## Stack Stack C
  10. Enable audio features in PITCHME.yaml

    master

    To activate audio features for your slide deck, add the audio-deck setting to your PITCHME.yaml file. You can also specify a global silent pause duration in seconds by providing a numeric value to this setting. This value determines how long a slide or fragment is displayed when no audio file is registered.

    • audio-deck : true: Enables audio features with the default 5-second silent pause.
    • audio-deck : <seconds>: Enables audio features and sets a custom global silent pause duration.