Skip to content
This repository was archived by the owner on Jul 16, 2020. It is now read-only.

Latest commit

 

History

History
47 lines (31 loc) · 962 Bytes

README.md

File metadata and controls

47 lines (31 loc) · 962 Bytes

hyper-markdown-preview

npm npm

A plugin to preview markdown files in your Hyper term.

Usage

Just type the location of your markdown file in your terminal.

screencapture

Install

Add the hyper-markdown-preview to your .hyper.js config file.

module.exports = {
    //...
    plugins: [
        `hyper-markdown-preview`
    ],
    //...
} 

Config

Since version 1.1 you can configure the stylesheets to use when rendering the markdown.

module.exports = {
    config: {
        // ...

        hyperMarkdownPreview: {
            stylesheet: 'github' // github | none
        }
    }
    
    // ...
}