marp-team / marp-team/marp-cli

Add cli option to exclude presenter notes from HTML output

Open
#701 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
3.8k
Forks
194
Avg merge
2h 51m
Merged PRs (30d)
3

Description

Currently, Marp cli includes presenter notes in the generated HTML output.

While these notes are hidden in the presentation view and only visible in presenter mode (via the 'P' key), they remain in the HTML source code.

Use Case:

When sharing HTML presentations with clients or external parties, presenters may want to completely exclude their internal notes from the deliverable file, rather than just hiding them visually.

Proposed Solution:

Add a cli flag to exclude presenter notes from the output.

Example:

marp presentation.md -o output.html --skip-notes
Current Workarounds:
  • Manually removing notes from source markdown
  • Post-processing HTML with scripts
  • Maintaining separate versions of presentations
Benefits:
  • Cleaner deliverables for client-facing presentations
  • No risk of exposing internal notes
  • Simpler workflow for users who share presentations

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Marp CLI option handling and the HTML output path that includes presenter notes. Add the documented --skip-notes behavior from the example, then verify that generated HTML omits presenter notes while normal output remains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.