https://github.com/minodisk/markn

Lightweight markdown viewer.
https://github.com/minodisk/markn

Last synced: about 2 months ago
JSON representation

Lightweight markdown viewer.

• Host: GitHub
• URL: https://github.com/minodisk/markn
• Owner: minodisk
• License: mit
• Created: 2015-06-30T06:03:52.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-16T10:16:22.000Z (over 8 years ago)
• Last Synced: 2024-07-25T14:25:49.020Z (2 months ago)
• Language: CSS
• Homepage: https://github.com/minodisk/markn/releases/latest
• Size: 1.35 MB
• Stars: 137
• Watchers: 4
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-electron-zh - Markn - Markdown viewer. (Apps / Open Source)
• awesome-electron - Markn - Lightweight Markdown viewer.  (Apps / Markdown)

README

        
# ![Markn](assets/title.png)

Lightweight markdown viewer.

## Features

- Only viewer.

  - You may use any editor you like.

- Live reload.

  - Re-render only changed elements.

    - Possible to preview huge markdown while editing.

    - Scroll position won't be changed while editing.

- Search text.

  - With regular expression.

- Load local images.

- Open a link to markdown in this application.

## Screenshot

![Demo](assets/demo.gif)

## Installation

1. Download zipped file from [latest release](https://github.com/minodisk/markn/releases/latest) and unzip it.

1. Double click Markn/Markn.app/Markn.exe.

## Components

Consists of awesome modules.

- [atom/electron](https://github.com/atom/electron)-based application.

- Render HTML with [facebook/react](https://github.com/facebook/react).

- Generate react elements from markdown AST with [mizchi/md2react](https://github.com/mizchi/md2react).

  - Generate markdown AST from markdown with [wooorm/mdast](https://github.com/wooorm/mdast).

- Watch file with [paulmillr/chokidar](https://github.com/paulmillr/chokidar).

- Style with [sindresorhus/github-markdown-css](https://github.com/sindresorhus/github-markdown-css).

  - Render some icons in [FortAwesome/Font-Awesome](https://github.com/FortAwesome/Font-Awesome).

  - Render emoji with [Ranks/emojione](https://github.com/Ranks/emojione).

  - Highlight code with [isagalaev/highlight.js](https://github.com/isagalaev/highlight.js)