potasiak / preview.md

Online Markdown editor with live preview.

Home Page:https://preview.md

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

preview.md

License: AGPL v3

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

Screenshot

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

About

Online Markdown editor with live preview.

https://preview.md

License:GNU Affero General Public License v3.0


Languages

Language:JavaScript 90.0%Language:SCSS 7.1%Language:HTML 2.9%