Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ screen-mirroring, the presenter is stuck seeing only the current slide, with no
to keep notes visible. This PDF Presenter solves exactly that by giving a dedicated control panel _(like PowerPoint or
Google Slides)_ while the audience sees a clean, full-screen view.

## How it works
## How It Works

The application is split into two browser tabs/windows:

Expand Down Expand Up @@ -53,10 +53,18 @@ in **16:9** format.

### Markdown Notes

The application allows the upload of presentation notes in **Markdown**. However not all formatting is parsed, sine
support for some features was intentionally deprioritized.
Upload your speaker notes as a **Markdown** file. The notes are rendered live in the control panel and stay
perfectly syncronized with the current slide.

Currently supported formatting include:
#### How Notes Sync With Slides

A top level heading _(`#`)_ acts as the marker for a new slide. Everything that follows a `#` heading belongs to that
specific slide, until the next top level heading appears.

To see this in action and get started quickly, check a ready to use example notes file in the repository:
[Examples](https://github.com/max-acc/pdf-presenter/tree/main/src/examples).

#### Supported Markdown Formatting

* Headings (`#`, `##`, `###`)
* Unordered lists _(first level only)_
Expand Down
27 changes: 27 additions & 0 deletions example/notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# This is the first slide

This document demos the capabilities of the control panel's markdown rendering.

# This is the second slide

This section specifies different levels of headings.

## This is a second level heading

### This is a third level heading

# This is the third slide

This section spcifies specific text rendering.

It is for example possible to render inline [links](https://github.com/max-acc/pdf-presenter).

# This is the fourth slide

This section specifies listing methods. Currently are only first level unordered lists
supported.

* First item
* Second item
* Third item
* Fourth item
Binary file added example/presentation.pdf
Binary file not shown.
Loading