Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 3.07 KB

README-en_US.md

File metadata and controls

60 lines (35 loc) · 3.07 KB

remark-it

markdown / html slideshow template, powered by remarkjs.

English | 简体中文

Demo

中文 Demo

English Demo

Why should you choose remark-it

  • Support for direct use of SVG images. When we need to insert flow chart or architecture diagram, use visio or drawio this kind of professional drawing software is more effective. Unfortunately, until 2020, PPT doesn't even support inserting SVG images. If we need to insert images produced by visio or drawio, we need export PNG images first, when inserting into PPT, a little carelessness will cause the picture to be blurred. In fact, both Visio and Drawio support saving drawings to editable SVG format, which not only supports lossless scaling, but also allows you to directly open the SVG document for editing when changes are needed.

  • Beautiful and consistent typography. Powerpoint text boxes are so hard to use! Getting the right line spacing, bullet points, and indentation takes a lot of time, and it's hard to keep the layout consistent throughout the whole presentation.

  • Write down your points directly by markdown. Markdown allows us to write beautiful documents in very little time, and inserting code is very convenient. And drawing syntax of Mermaid and formula based on MathJax is supported.

  • More version-friendly. Since both the doc and the graphics (SVGis essentially an XML document) are textual, why not manage them with Git?

  • Easy to share on the Internet. When you need to share your slides, just upload it to github.

Why shouldn't you choose remark-it

  • Your company explicitly require templates in a specific format.

  • When you help your boss with the powerpoint presentation, he has to change it.

  • When the layout is particularly complex.

  • Special effects such as cut scenes are required.

Features

  • All resources support offline access
  • Remarkjs Samples
  • English and Chinese typography, powered by Typo.css
  • Multi-column layouts, powered by Pure.css
  • Dark ann light theme, powered by Nord
  • 150 text and background colors, powered by Open color
  • Components powered by Vue.js
  • Markdown Diagrams powered by Mermaid
  • Automatic mixing typesetting in both English and Chinese powered by pangu.js

Installation

Clone the whole project and edit index.html.

Usage

Double-click on index.html for a slide presentation.

License

MIT