# @burgetr/gitshow

> Presentation maker from markdown source files

Latest version **2.0.1** (published 2026-09-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @burgetr/gitshow
pnpm add @burgetr/gitshow
yarn add @burgetr/gitshow
bun add @burgetr/gitshow
```

Provides the command `gitshow`.

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2026-09-22 |
| First published | 2023-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 86.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 1 |
| Author | Radek Burget |
| Maintainers | burgetr |

## Links

- npm: https://www.npmjs.com/package/@burgetr/gitshow
- Repository: https://github.com/gitshow-js/gitshow
- Homepage: https://github.com/gitshow-js/gitshow#readme
- Issues: https://github.com/gitshow-js/gitshow/issues
- npm.io page: https://npm.io/package/@burgetr/gitshow

## Dependencies (15)

- [gulp](https://npm.io/package/gulp.md) ^5.0.0
- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [rollup](https://npm.io/package/rollup.md) ^4.1.5
- [core-js](https://npm.io/package/core-js.md) ^3.33.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.3.1
- [gulp-zip](https://npm.io/package/gulp-zip.md) ^5.1.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^23.4.0
- [reveal.js](https://npm.io/package/reveal.js.md) ^5.2.1
- [gulp-connect](https://npm.io/package/gulp-connect.md) ^5.7.0
- [gulp-replace](https://npm.io/package/gulp-replace.md) ^1.1.4
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.23.2
- [@rollup/plugin-babel](https://npm.io/package/@rollup/plugin-babel.md) ^6.0.4
- [@rollup/plugin-terser](https://npm.io/package/@rollup/plugin-terser.md) ^0.4.4
- [@rollup/plugin-commonjs](https://npm.io/package/@rollup/plugin-commonjs.md) ^25.0.7
- [@rollup/plugin-node-resolve](https://npm.io/package/@rollup/plugin-node-resolve.md) ^15.2.3

## Recent versions

- 2.0.1 (latest) — 2026-09-22
- 2.0.0 — 2023-09-01
- 1.0.2 — 2023-06-27
- 1.0.1 — 2023-06-27

## README

# GitShow - Create presentations from Markdown sources

GitShow generates a [Reveal.js](https://revealjs.com) presentation from a set of plain markdown files. It allows to maintain the presentation sources separately (e.g. in a git repository) and to quickly [show it online](https://github.com/gitshow-js/gitshow-view#readme), generate a static web server-ready presentation or a PDF. See [demo presentations](https://github.com/gitshow-js/demos) for a few examples of presentation sources.

GitShow provides a pre-configured (but still configurable) Reveal.js environment, allowing the author to focus on creating mardown files (which can even be done directly on GitHub). It also allows the use of built-in or custom templates that define the visual style of the presentation. Knowledge of HTML, CSS, JavaScript and other related technologies is not required, but very helpful.

## Requirements

GitShow requires `node.js` and `npm` installed, e.g. from [NodeSource](https://github.com/nodesource/distributions) (linux) or [nodejs.org](https://nodejs.org/en/download/prebuilt-installer) (windows).
Any web browser is sufficient for viewing the final presentations.

## Installation

Install the command line tool:

```bash
npm install -g @burgetr/gitshow
```

## Creating presentations

Create a new presentation:

```bash
mkdir my-presentation
cd my-presentation
gitshow init
```

The `presentation.json` file now contains the presentation configuration. Edit the configuration and markdown files to add some content to the presentation. See the [reveal.js documentation](https://revealjs.com/markdown/) for information on how to use markdown in the presentation.

Get a live preview of the presentation by running

```bash
gitshow serve
```

and visiting `http://localhost:8000` with your web browser. The presentation is automatically updated when the source files change.

The PDF version of the presentation can be created using

```bash
gitshow pdf
```

A ZIP package containing a static, web server-ready HTML presentation can be created using

```bash
gitshow package
```

## Show your presentations online

If you share your presentation markdown sources in a public GitHub repository, [GitShow Viewer](https://github.com/gitshow-js/gitshow-view#readme) can be used for directly showing in online.

## Acknowledgements

Many thanks to [Reveal.js](https://revealjs.com/) authors and contributors for creating such a great presentation framework.

---
_Source: https://npm.io/package/@burgetr/gitshow · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
