From 2be04c6f93bb354cf10c850eba4eb59e81421194 Mon Sep 17 00:00:00 2001 From: David Cox-Espenlaub Date: Thu, 22 Mar 2012 16:04:46 -0400 Subject: [PATCH] ok, really, just cleaning up docs and setting things on fire. --- README.md | 30 +++++++++++++++++------------- View Markdown/markdown_viewer.py | 28 +--------------------------- 2 files changed, 18 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 208999a..f9f8976 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,24 @@ *By David Cox-Espenlaub* -* Uses WolfieZero's Markdown-Viewer-PHP as configured as a local site (per the project's instructions) - https://github.com/WolfieZero/Markdown-Viewer-PHP - -* Currently in Alpha, script works from console in Sublime Text 2, but not as a plugin -* Requires the following settings in Preferences.sublime-settings: -` - "markdown_viewer": - { - "url":"http://markdown.local/", - "extended":"True" - } -` +## About + +* Uses [WolfieZero's Markdown-Viewer-PHP](https://github.com/WolfieZero/Markdown-Viewer-PHP "Link to GitHub") as configured as a local site (per the project's instructions) + +* Tested in [Sublime Text 2 Beta, Build 2190](http://www.sublimetext.com/dev "Link to Sublimetext 2 Dev Builds") + +## Settings + +* Uses the following settings in 'View Markdown.sublime-settings': + + "markdown_viewer": + { + "url":"http://markdown.local/", + "extended":"True" + } + * Replace the value for "url" with your local url -* Set "extended" to "" or remove the setting if you only want to use normal Markdown +* Set "extended" to "" or remove the setting if you only want to use normal Markdown, set to "True" for extended markdown ## To-Do diff --git a/View Markdown/markdown_viewer.py b/View Markdown/markdown_viewer.py index 1781d42..1ac9b61 100644 --- a/View Markdown/markdown_viewer.py +++ b/View Markdown/markdown_viewer.py @@ -5,33 +5,7 @@ For documentation of the webbrowser module, see http://docs.python.org/library/webbrowser.html -Plugin has the following settings in View Markdown.sublime-settings -` - "markdown_viewer": - { - "url":"http://markdown.local/", - "extended":"True" - } -` -Edit these using the command pallette - -* The value of "url" ("http://markdown.local") should be your local url for WolfieZeros PHP Markdown viewer - (https://github.com/WolfieZero/Markdown-Viewer-PHP) - -* The value of "extended" is either "True" or "" depending on whether you want the Markdown Extended support - -To Execute: -* From the console (ctrl + `) run -` - view.run_command('view_markdown') -` - -* This is the default key binding for all platforms: -` - { "keys": ["ctrl+alt+m"], "command": "view_markdown" } -` - The key binding files can be found in the plugin directory, and modified accordingly. - +See https://github.com/daveespionage/Sublime-Text-2-Markdown-Viewer-Plugin for more details """ import os