https://github.com/yashsriv/instant-pandoc-d

A Small Instant Preview Server for Pandoc Markdown Syntax to HTML5
https://github.com/yashsriv/instant-pandoc-d

Last synced: 9 days ago
JSON representation

A Small Instant Preview Server for Pandoc Markdown Syntax to HTML5

• Host: GitHub
• URL: https://github.com/yashsriv/instant-pandoc-d
• Owner: yashsriv
• License: mit
• Created: 2016-11-17T16:55:48.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-15T10:52:18.000Z (over 7 years ago)
• Last Synced: 2025-01-03T17:06:57.077Z (21 days ago)
• Language: CSS
• Size: 21.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
!nstant-pandoc-d

================

instant-pandoc-d is a Node.js server based on @suan's

[instant-markdown-d]("https://github.com/suan/instant-markdown-d").

Full credit goes to @suan for the original server. This is merely

a ripoff made to work with pandoc as well.

This enables instant previewing of pandoc Markup files. A plugin

can easily be written for any text editor to interface with it. There is

one in planning for vim and which will hopefully be available at:

[https://github.com/yashsriv/vim-instant-pandoc](https://github.com/yashsriv/vim-instant-pandoc)

Prerequisites

-------------

- A html5 compatible browser set as your default browser

- `pandoc` cli installed (duh!!)

Installation

------------

- `[sudo] npm -g install instant-pandoc-d`

REST API

--------

|          Action          | HTTP Method |        Request URL        |         Request Body         |

| :----------------------: | :---------: | :-----------------------: | :--------------------------: |

| Refresh Markdown on page |     PUT     | http://localhost:\ | \ |

|       Close Webpage      |    DELETE   | http://localhost:\ |                              |

By default, \ is `8090`, but it can be specified while starting server like:

```shell

$ instant-pandoc-d -p 80

```

_Copied_ exactly from @suan's repo:

Environment variables

---------------------

* `INSTANT_MARKDOWN_OPEN_TO_THE_WORLD=1` - by default, the server only listens

  on localhost. To make the server available to others in your network, set this

  environment variable to a non-empty value. Only use this setting on trusted

  networks!

* `INSTANT_MARKDOWN_ALLOW_UNSAFE_CONTENT=1` - by default, scripts are blocked.

  Use this preference to allow scripts.

* `INSTANT_MARKDOWN_BLOCK_EXTERNAL=1` - by default, external resources such as

  images, stylesheets, frames and plugins are *allowed*. Use this setting to

  *block* such external content.