preview.md

This is a repository used for preview.md - an online Markdown editor with live preview.

Features

• Github-inspired Markdown rendering, including syntax highlighting in the code blocks.
• Support for Github-Flavored Markdown.
• Markdown syntax highlighting in the editor.
• Syntax highlighting in the code blocks in the editor.
• Scroll synchronization.
• Copy raw markdown or resulting HTML with one click.
• Change panes orientation (horizontal / vertical).
• Mobile support.
• Saving state, including content, in local storage.

Requirements

• node.js v21.1.0
• yarn

Installation

1. Clone the repository

   git clone https://github.com/potasiak/preview.md.git

2. Install dependencies

   cd preview.md/
   yarn

Running

Required environment variables

• VITE_GA_TAG_ID - Google Analytics Tag

Development

yarn dev

Production

yarn build
yarn preview  # local HTTP server serving built application

Credits

• Sebastian Potasiak