add option: keep the md view when previewing #13

Keep the markdown view opened in the original window when when opening
the preview

.sublime/MarkdownLivePreview.sublime-settings

@@ -1,4 +1,12 @@
 {
+    // As soon as you open a markdown file, it opens the window preview
     "markdown_live_preview_on_open": false,
-    "load_from_internet_when_starts": ["http://", "https://"]
+
+    // If an image starts with one of those strings, then it will be loaded from internet
+    "load_from_internet_when_starts": ["http://", "https://"],
+
+    // When the preview is opened, the markdown file is closed in the origin window and reopend in
+    // the preview window. If this option is set to 'true', then the markdown file will NOT be
+    // closed in the origin window
+    "keep_open_when_opening_preview": false
 }

MLPApi.py

@@ -30,13 +30,6 @@ def plugin_loaded():
     else:
         DEFAULT_STYLE_FILE = sublime.load_resource('Packages/MarkdownLivePreview/default.css')
 
-def get_preview_name(md_view):
-    file_name = md_view.file_name()
-    name = md_view.name() \
-           or os.path.basename(file_name) if file_name else None \
-           or 'Untitled'
-    return name + ' - Preview'
-
 def create_preview(window, file_name):
     preview = window.new_file()
 
@@ -55,20 +48,37 @@ def get_style():
     return content
 
 def markdown2html(md, basepath):
-    html = ''
-    html += '<style>\n{}\n</style>\n'.format(get_style())
-    # pre_with_br
-    html += pre_with_br(pre_tables(md2.markdown(md, extras=['fenced-code-blocks',
-                                                            'no-code-highlighting', 'tables'])))
+    html = '<style>\n{}\n</style>\n'.format(get_style())
+
     # the option no-code-highlighting does not exists in the official version of markdown2 for now
     # I personaly edited the file (markdown2.py:1743)
+    html += md2.markdown(md, extras=['fenced-code-blocks', 'no-code-highlighting', 'tables'])
 
-    html = html.replace('&nbsp;', '&nbspespace;') # save where are the spaces
+    # tables aren't supported by the Phantoms
+    # This function transforms them into aligned ASCII tables and displays them in a <pre> block
+    # (the ironic thing is that they aren't supported either :D)
+    html = pre_tables(html)
 
+    # pre block are not supported by the Phantoms.
+    # This functions replaces the \n in them with <br> so that it does (1/2)
+    html = pre_with_br(html)
+
+    # comments aren't supported by the Phantoms
+    # Simply removes them using bs4, so you can be sadic and type `<!-- hey hey! -->`, these one
+    # won't be stripped!
+    html = strip_html_comments(html)
 
     # exception, again, because <pre> aren't supported by the phantoms
-    html = html.replace('&nbspespace;', '<i class="space">.</i>')
+    # so, because this is monosaped font, I just replace it with a '.' and make transparent ;)
+    html = html.replace('&nbsp;', '<i class="space">.</i>')
+
+    # Phantoms have problem with images size when they're loaded from an url/path
+    # So, the solution is to convert them to base64
     html = replace_img_src_base64(html, basepath=os.path.dirname(basepath))
+
+    # BeautifulSoup uses the <br/> but the sublime phantoms do not support them...
+    html = html.replace('<br/>', '<br />')
+
     return html
 
 def show_html(md_view, preview):

MarkdownLivePreview.py

@@ -15,6 +15,7 @@ class NewMarkdownLivePreviewCommand(sublime_plugin.ApplicationCommand):
 
         current_view = sublime.active_window().active_view()
         file_name = current_view.file_name()
+        if get_settings().get('keep_open_when_opening_preview') is False:
             current_view.close()
         if file_name is None:
             return sublime.error_message('MarkdownLivePreview: Not supporting '

MarkdownLivePreview.tasks

@@ -1,5 +1,6 @@
 Fast:
   ☐ cache image in object when used, so that it's faster @needsTest
+  ☐ add settings to keep md view open #13
 
 Medium:
   ☐ auto refresh preview if loading images

docs/index.md

@@ -139,10 +139,10 @@ Here's what I'd recommend (and use):
     originally hidden
 
 That's it! I hope you'll enjoy using this package! If it's the case, please let your friends know
-about it, and even myself by sending me a [tweet][] or staring the repo
+about it, and even myself by sending me a [tweet][] or staring the repo!
 <iframe
 src="https://ghbtns.com/github-btn.html?user=math2001&repo=MarkdownLivePreview&type=star&count=true&size=large"
-frameborder="0" scrolling="0" width="160px" height="30px"></iframe>!
+frameborder="0" scrolling="0" style="width: 120px; height: 30px; vertical-align: bottom"></iframe>
 
 [st]: https://sublimetext.com
 [Markdown Extended]: https://packagecontrol.io/packages/Markdown%20Extended

docs/license.md

@@ -0,0 +1,24 @@
+This project is published under MIT license.
+
+> The MIT License is a permissive license that is short and to the point. It lets people do anything
+> they want with your code as long as they provide attribution back to you and don’t hold you
+> liable.
+>
+> — *from [choosealicense.com](http://choosealicense.com), by [GitHub](https://github.com)*
+
+Copyright 2017 Mathieu PATUREL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+andassociated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

functions.py

@@ -4,39 +4,41 @@ import os.path
 import sublime
 import re
 from .image_manager import ImageManager
-from bs4 import BeautifulSoup
+from bs4 import BeautifulSoup, Comment as html_comment
 
 def plugin_loaded():
     global error404, loading
     loading = sublime.load_resource('Packages/MarkdownLivePreview/loading.txt')
     error404 = sublime.load_resource('Packages/MarkdownLivePreview/404.txt')
 
+def strip_html_comments(html):
+    soup = BeautifulSoup(html, 'html.parser')
+    for element in soup.find_all(text=lambda text: isinstance(text, html_comment)):
+        element.extract()
+    return str(soup)
+
+
+def get_preview_name(md_view):
+    file_name = md_view.file_name()
+    name = md_view.name() \
+           or os.path.basename(file_name) if file_name else None \
+           or 'Untitled'
+    return name + ' - Preview'
 
 def replace_img_src_base64(html, basepath):
-    """Really messy, but it works (should be updated)"""
-    index = -1
-    tag_start = '<img src="'
-    shtml, html = html, list(html)
-    while True:
-        index = shtml.find(tag_start, index + 1)
-        if index == -1:
-            break
-        path, end = get_content_till(html, '"', start=index + len(tag_start))
-        if ''.join(path).startswith('data:image/'):
+    soup = BeautifulSoup(html)
+    load_from_internet_starters = get_settings().get('load_from_internet_when_starts')
+    for img in soup.find_all('img'):
+        if img['src'].startswith('data:image/'):
             continue
-        if ''.join(path).startswith(tuple(get_settings().get('load_from_internet' + \
-                                                    '_when_starts', []))):
-            image = ImageManager.get(''.join(path))
-            image = image or loading
+        elif img['src'].startswith(tuple(load_from_internet_starters)):
+            image = ImageManager.get(img['src']) or loading
+        else: # this is a local image
+            image = to_base64(os.path.join(basepath, src))
 
-        else:
-            # local image
-            path = ''.join(path)
-            path = os.path.join(basepath, path)
-            image = to_base64(path)
-        html[index+len(tag_start):end] = image
-        shtml = ''.join(html)
-    return ''.join(html)
+        img['src'] = image
+
+    return str(soup)
 
 def is_markdown_view(view):
     return 'markdown' in view.scope_name(0)
@@ -95,4 +97,4 @@ def pre_with_br(html):
         code = pre.find('code')
         code.replaceWith(BeautifulSoup(''.join(str(node) for node in pre.contents) \
                       .replace('\n', '<br/>').replace(' ', '<i class="space">.</i>'), 'html.parser'))
-    return str(soup).replace('<br/>', '<br />')
+    return str(soup)

sample.md

@@ -1,5 +1,9 @@
 # Hello world
 
+<!-- supports comments -->
+
+And `<!-- vicious ones ;) -->`
+
 Some `inline code` with *italic* and **bold** text.
 
 ```python
@@ -24,7 +28,7 @@ if you is moods.curious:
 | 45        | John  |
 | `<table>` | `><`  |
 
-[Sublime Text Logo](https://upload.wikimedia.org/wikipedia/en/4/4c/Sublime_Text_Logo.png)
+![Sublime Text Logo](https://upload.wikimedia.org/wikipedia/en/4/4c/Sublime_Text_Logo.png)
 
 Some plugin I just *need*: