https://github.com/mvr-studio/shw

Present quick Markdown presentations by running a simple CLI command.
https://github.com/mvr-studio/shw

cli ink markdown presentations react

Last synced: 2 months ago
JSON representation

Present quick Markdown presentations by running a simple CLI command.

• Host: GitHub
• URL: https://github.com/mvr-studio/shw
• Owner: mvr-studio
• Created: 2022-04-30T20:24:44.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-05-02T11:50:58.000Z (about 3 years ago)
• Last Synced: 2025-03-14T15:06:42.762Z (3 months ago)
• Topics: cli, ink, markdown, presentations, react
• Language: TypeScript
• Homepage:
• Size: 251 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# shw (Showdown) - Quick CLI presentations

Lo-fi CLI presentation tool. Make Markdown based presentations by running a simple CLI command.

## Prerequisite

- Node.js (>=10)

## Installation

### Usign NPM:

```bash

$ npm i -g shw

```

### Usign Yarn:

```bash

$ yarn global add shw

```

## Usage

### Module installed locally

```

$ shw presentation.md

```

### Without installing

```

$ npx shw presentation.md

```

![shw](/demo.gif)

## Features

- Metadata reading (title, author, email)

- [Synthax highlighting](https://github.com/thlorenz/cardinal)

- Zero config

## Links

- [Example](/examples/demo.md)