Skip to content

remark

A simple tool that turns Markdown text into a browser-based slideshow.

Stars
13k
Forks
862
Licence
MIT
Language
JavaScript
Last update
2.4 years ago
Type
Library

No commits in over a year — check for forks or alternatives before adopting.

What it is

remark is a JavaScript library that renders a slideshow in a web browser from Markdown text placed inside an HTML file. You write slides separated by dividers, open the page, and it displays them. It is aimed at people who already know some HTML and CSS, since styling is done with ordinary CSS.

  • Build a talk or lecture as a single HTML file with Markdown slides
  • Show code samples with syntax highlighting across slides
  • Present from a second window using presenter mode with Markdown speaker notes
  • Export slides to PDF using Chrome's print feature or DeckTape

Great for

  • People comfortable with HTML and CSS who want slides written in Markdown
  • Developers or teachers who want a presentation they can version-control as plain text
  • Presenters who want a speaker-notes view with a cloned display

Not ideal for

  • Non-technical users who want a visual slide editor, since the README describes editing HTML and Markdown by hand
  • People who need an offline presentation without building remark first, since the README notes the local boilerplate requires a build step
  • Users who need built-in PDF export, since the README says PDF output relies mainly on Chrome's Print to PDF and styling is not exact
Step-by-step guide: how to use remarkInstall, first run, examples, tips and FAQs

How to get it

  1. 1

    Download the app

    You'll need: A modern web browser

    Clone the repository

    git clone https://github.com/gnab/remark
  2. 2

    Run it

    • Create an HTML file using the boilerplate in the README
    • Open the HTML file in a web browser
    • Edit the Markdown slides and save, then refresh the page
    • Press C to clone the display and P to switch to presenter mode
  3. 3

    Get the most out of it

    • Use the wiki pages referenced in the README for templating and API help
    • Add custom CSS in the head section to style fonts and layouts
    • Try the Remarkise link in the README to render Markdown slideshows on the fly
    • Use the -local boilerplate after building remark if you want to avoid remote scripts

Downloads

Strengths

  • Simple model: one HTML file with Markdown slides inside
  • Presenter mode with speaker notes and a cloned view
  • Works on touch devices with swipe navigation

Trade-offs

  • Targeted at people who know HTML and CSS, so it is not a point-and-click tool
  • PDF export styling is not guaranteed to match the browser view
  • The README's boilerplate loads resources from remote URLs, so an internet connection is typically needed unless you build locally

How it compares

ProjectStarsTypeLevelUpdatedBest for
remark (this)13kLibrarybeginner2.4 years agoPeople comfortable with HTML and CSS who want slides written in Markdown
reveal.js72.5kLibraryintermediate1 months agoDevelopers who already write HTML, CSS, or JavaScript and want full control over slide design
marp12.7kOtherbeginner3 months agoPeople who prefer writing slides as Markdown text rather than in a visual editor
slidev49.3kDev toolbeginner14 days agoDevelopers who want to present code, technical talks, or architecture diagrams
impress.js38.2kLibraryintermediate4 months agoWeb developers who want a custom, browser-based slide deck
tui.editor18kLibraryintermediate2.3 years agoWeb developers who want an embeddable Markdown editor in their own site or app

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.