Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,17 @@ | ||
!nstant-markdown | ||
!nstant-markdown-d | ||
================ | ||
instant-markdown-d is a small Node.js server that enables instant compilation and previewing of Markup files. A plugin can easily be written for any text editor to interface with it. One currently exists for VIm: https://github.com/suan/vim-instant-markdown | ||
|
||
API | ||
--- | ||
| Action | HTTP Method | Request URL | Request Parameters | | ||
Installation | ||
------------ | ||
- `[sudo] gem install redcarpet pygments.rb` | ||
- `[sudo] npm -g install instant-markdown-d` | ||
|
||
REST API | ||
-------- | ||
| Action | HTTP Method | Request URL | Request Body | | ||
|---------------------|-------------|---------------------------|--------------------| | ||
| Open (blank) Webpage| GET | http://localhost:\<port\> || | ||
| Refresh Markdown | PUT | http://localhost:\<port\> | contents=\<Markdown file contents\> (Multipart form data) | | ||
| Refresh Markdown on page | PUT | http://localhost:\<port\> | \<New Markdown file contents\> | | ||
| Close Webpage | DELETE | http://localhost:\<port\> | | | ||
|
||
By default, `<port>` is 8090 |