Merge pull request #1 from treatmesubj/live-md

Live markdown rendering

Author: treatmesubj

README.md

@@ -15,9 +15,11 @@ It makes for a simple way to write up some Markdown with a terminal & a web brow
 ## Usage
 ### Markdown-to-HTML Server
 ```
-python -m httpmdhtml.server -b 127.0.0.1 -d . --css_file ../mystyle.css
+python -m httpmdhtml.server -b 127.0.0.1 -d . --css_file ../mystyle.css -l 5000
 ---
-usage: server.py [-h] [--cgi] [--bind ADDRESS] [--directory DIRECTORY] [--css_file CSS_FILE] [port]
+usage: server.py [-h] [--cgi] [--bind ADDRESS] [--directory DIRECTORY] [--css_file CSS_FILE]
+                 [--live_md_rr LIVE_MD_RR]
+                 [port]
 
 positional arguments:
   port                  Specify alternate port [default: 8000]
@@ -30,6 +32,8 @@ optional arguments:
   --directory DIRECTORY, -d DIRECTORY
                         Specify alternative directory [default:current directory]
   --css_file CSS_FILE   css-file-path; its content will be written to the <style> element
+  --live_md_rr LIVE_MD_RR, -l LIVE_MD_RR
+                        continuous refresh rate of MD page, in ms
 ```
 
 ### Markdown-to-HTML Out-File

httpmdhtml/md_to_html.py

@@ -12,7 +12,7 @@
 
 
 def markdown_to_html(MarkdownIt_obj, in_file_path, out_file_path="tmp.html",
-        encode_local_images=False, css_file=None):
+        encode_local_images=False, css_file=None, live_md_rr=None):
 
     text = open(in_file_path, "r").read()
     tokens = MarkdownIt_obj.parse(text)
@@ -31,6 +31,10 @@ def markdown_to_html(MarkdownIt_obj, in_file_path, out_file_path="tmp.html",
         code { color: #ae81ff; background-color: #272b33; border-radius: 6px; }
         table, th, td { border: 1px solid; border-collapse: collapse; padding-left: 4px; padding-right: 4px; }"""
     soup.select_one("style").string = css
+    if live_md_rr:
+        script = f"setTimeout(function(){{ document.location.reload(); }}, {live_md_rr});"
+        soup.select_one('head').append(soup.new_tag("script"))
+        soup.select_one("script").string = script
     if encode_local_images:
         img_elems = soup.select("img")
         url_pattern = "^https?:\\/\\/(?:www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)$"

httpmdhtml/server.py

@@ -31,23 +31,25 @@
 
 
 class md_to_html_SimpleHTTPRequestHandler(SimpleHTTPRequestHandler):
-    def __init__(self, *args, MarkdownIt_obj=None, css_file=None, **kwargs):
+    def __init__(self, *args, MarkdownIt_obj=None, css_file=None, live_md_rr=False, **kwargs):
         self.MarkdownIt_obj = MarkdownIt_obj
         self.css_file = css_file
+        self.live_md_rr = live_md_rr
         super().__init__(*args, **kwargs)
 
 
     def do_GET(self, rm_temp_html=False):
         """Serve a GET request."""
         self.url_dc_path = urllib.parse.unquote(urllib.parse.urlsplit(self.path).path)  # url decode, strip query params for file check
-        if self.url_dc_path.endswith(".md") and os.path.exists(os.path.join(self.directory, f".{self.url_dc_path}")):  # check for markdown file request
+        if self.MarkdownIt_obj and self.url_dc_path.endswith(".md") and os.path.exists(os.path.join(self.directory, f".{self.url_dc_path}")):  # check for markdown file request
             in_file_path=os.path.join(self.directory, f".{self.url_dc_path}")
             out_file_path=os.path.join(self.directory, f".{os.path.splitext(self.url_dc_path)[0]}.html")
             md_to_html.markdown_to_html(
                     self.MarkdownIt_obj,
                     in_file_path=in_file_path,
                     out_file_path=out_file_path,
-                    css_file=self.css_file)
+                    css_file=self.css_file,
+                    live_md_rr=self.live_md_rr)
             self.path = f"{os.path.splitext(self.path)[0]}.html"
             rm_temp_html = True
         f = self.send_head()
@@ -73,6 +75,8 @@ def do_GET(self, rm_temp_html=False):
                         '[default:current directory]')
     parser.add_argument('--css_file', default=None,
                          help='css-file-path; its content will be written to the <style> element')
+    parser.add_argument('--live_md_rr', '-l', action='store', type=int, default=None,
+                         help='continuous refresh rate of MD page, in ms')
     parser.add_argument('port', action='store',
                         default=8000, type=int,
                         nargs='?',
@@ -83,11 +87,12 @@ def do_GET(self, rm_temp_html=False):
     else:
         MarkdownIt_obj = MarkdownIt("commonmark").enable("table").enable("strikethrough")
         if args.css_file and not os.path.isfile(args.css_file):
-            raise FileNotFoundError(f"looks like the given `css_file` argument's value - {args.css_file} - is not actually a file")
+            raise FileNotFoundError(f"looks like the given `css_file` argument's value - {args.css_file} - cannot be found")
         handler_class = partial(md_to_html_SimpleHTTPRequestHandler,
                                 directory=args.directory,
                                 MarkdownIt_obj=MarkdownIt_obj,
-                                css_file=args.css_file)
+                                css_file=args.css_file,
+                                live_md_rr=args.live_md_rr)
 
     # ensure dual-stack is not disabled; ref #38907
     class DualStackServer(ThreadingHTTPServer):

setup.py

@@ -6,15 +6,15 @@
 
 setup(
     name="httpmdhtml",
-    version="0.0.6",
+    version="0.0.7",
     license="gpl-3.0",
     author="John Hupperts",
     author_email="[email protected]",
     description="HTTP server that converts markdown to HTML",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/treatmesubj/python-md-to-html-server",
-    download_url="https://github.com/treatmesubj/python-md-to-html-server/archive/refs/tags/v0.0.6.tar.gz",
+    download_url="https://github.com/treatmesubj/python-md-to-html-server/archive/refs/tags/v0.0.7.tar.gz",
     packages=["httpmdhtml"],
     package_dir={"python-md-to-html-server": "httpmdhtml"},
     project_urls={