remark README

The project's README from github.com/gnab/remark. As one markdown file: README.md.

remark

Build Status CDNJS xscode Donate

A simple, in-browser, markdown-driven slideshow tool targeted at people who know their way around HTML and CSS, featuring:

Check out this remark slideshow for a brief introduction.

To render your Markdown-based slideshow on the fly, checkout Remarkise.

Getting Started

It takes only a few, simple steps to get up and running with remark:

  1. Create an HTML file to contain your slideshow (see boilerplate below)
  2. Open the HTML file in a decent browser
  3. Edit the Markdown and/or CSS styles as needed, save and refresh!
  4. Press C to clone a display; then press P to switch to presenter mode. Open help menu with h.

See any of the boilerplate-*.html files (the -local one requires building remark first), or just copy the boilerplate HTML below to start:

<!DOCTYPE html>
<html>
  <head>
    <title>Title</title>
    <meta charset="utf-8">
    <style>
      @import url(https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz);
      @import url(https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic);
      @import url(https://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700,400italic);

      body { font-family: 'Droid Serif'; }
      h1, h2, h3 {
        font-family: 'Yanone Kaffeesatz';
        font-weight: normal;
      }
      .remark-code, .remark-inline-code { font-family: 'Ubuntu Mono'; }
    </style>
  </head>
  <body>
    <textarea id="source">

class: center, middle

# Title

---

# Agenda

1. Introduction
2. Deep-dive
3. ...

---

# Introduction

    </textarea>
    <script src="https://remarkjs.com/downloads/remark-latest.min.js">
    </script>
    <script>
      var slideshow = remark.create();
    </script>
  </body>
</html>

How To Use remark

The wiki pages contain all the how-to, templating, and API help.

Real-world remark slideshows

On using remark:

Other interesting stuff:

Printing

Converting to PDF is primarily supported via Chrome's Print to PDF feature. Note that the styling is not exact; See #50 for some recommended CSS to add to your styles.

Alternatively, you can use DeckTape, a PDF exporter for HTML presentation frameworks that provides support for remark.

Contributors

Thanks goes to these people for their contributions:

License

remark is licensed under the MIT license. See LICENSE for further details.

remark (gnab/remark)

Searching Database…

13K ·GitHub
Remark
Что это такое?remark — это простой инструмент для создания слайд-шоу в браузере, который работает с Markdown и рассчитан на людей, уверенно владеющих HTML и CSS. Слайды пишутся в Markdown, а remark отображает их в браузере как живую презентацию.
Это JavaScript-библиотека, которую нужно собирать, или просто HTML-файл, который открывается в браузере?Это обычный HTML-файл: вы создаёте один HTML-файл со слайдами в Markdown и открываете его прямо в браузере, никакой сборки не требуется.
Как запустить слайд-шоу?Создайте HTML-шаблон, откройте его в браузере, затем редактируйте содержимое в Markdown и стили CSS и обновите страницу, чтобы увидеть изменения.
Нужны ли Node или инструменты сборки, чтобы пользоваться этим?Нет, remark включает сам парсер Markdown и работает прямо в браузере из одного HTML-файла; Node нужен только если вы хотите собрать remark локально для шаблона '-local'.
Можно ли экспортировать слайд-шоу в аккуратный PDF?Можно напечатать в PDF через Chrome, но оформление будет не совсем точным; для точного экспорта в PDF в README рекомендуется использовать DeckTape.
Для кого предназначен этот инструмент для слайд-шоу?Он рассчитан на людей, которые сами умеют писать HTML и CSS, например на разработчиков, которые читают технические доклады или лекции, а не на нетехнических докладчиков.
Работает ли презентация и на планшетах, и на телефонах?Да, в remark есть поддержка сенсорного управления с жестами смахивания, поэтому слайд-шоу работают на смартфонах и планшетах так же, как в браузерах на компьютерах.
Как пользоваться режимом докладчика с заметками?Нажмите C, чтобы клонировать вывод во второе окно, затем нажмите P в этом клонированном окне, чтобы переключить его в режим докладчика; он покажет ваши заметки, оформленные в Markdown, рядом со слайдами.
Поддерживает ли remark блоки кода с подсветкой синтаксиса?Да, есть встроенная подсветка синтаксиса для целого ряда языков программирования в коде, который показан на слайдах.
Где найти документацию по шаблонам и API?На страницах GitHub wiki проекта есть инструкции, документация по шаблонам и API для настройки слайдов.
Одинаково ли выглядят слайды на разных размерах экрана?Да, remark масштабирует слайды, поэтому они выглядят примерно одинаково на разных устройствах и при разных разрешениях.
What are similar projects?nodeppt, reveal.js, frontend-slides, editor.md, html-ppt-skill, marp, impress.js, open-slide
Which topics is it in?slideshow, navigation, touch, slides, templates, presentation, syntax-highlighting, javascript-library, pdf, css, html, markdown
Creator
gnab
Size
7 MB
Stars
13K
Updated
CommitJun 27Releasev0.15.0Jan 18
Age
15y
Commits · 90 Days