Permalink
Browse files

ok, really, just cleaning up docs and setting things on fire.

  • Loading branch information...
1 parent 2faf83b commit 2be04c6f93bb354cf10c850eba4eb59e81421194 David Cox-Espenlaub committed Mar 22, 2012
Showing with 18 additions and 40 deletions.
  1. +17 −13 README.md
  2. +1 −27 View Markdown/markdown_viewer.py
View
@@ -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
@@ -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

0 comments on commit 2be04c6

Please sign in to comment.