github-markdown-server 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f1f3e1b6c0b783128c49522e43ed9a0adad443c
-  data.tar.gz: 9b81373d11efa51e007e87e495ad1a65fecc640a
+  metadata.gz: b494d220af9950651041ea55cf4d4b20280ced3e
+  data.tar.gz: 7e6c5f2599a92bd9a76d2b068458d2d1eee31dae
 SHA512:
-  metadata.gz: 6c6de876abe5323c3fcb788827e2a76c9c244da3afa336ea5fdb649c5aeaee12bb28dec649a43563ed95df8724f3c733c27a7228631ca016eb63b3c01e884b95
-  data.tar.gz: a998e171e149d42f06941a553335791c7faeb70f20570616e61f87f18c7863678d12f3c36d3d1dd977ce3d8df18b968814e8d73f6e46a8e24ac143c51fb1b0f9
+  metadata.gz: 13a669ea9878cd574e06cd36b33f8468032c0ceb5741e947caa8a6f033fa40bb0070ded07f419dd558265dd3db8be3792104a1458311401123259bd991dcd938
+  data.tar.gz: 09fe4e4def06aa10f73b1b7028ce9a7375c6a477e513c26f0427da45a1fc7dec98fb0fbc846824d8f696b6a38a303a95ae3a13beffc668a31f6a4914230c44aa

data/README.md

@@ -13,12 +13,16 @@ github-markdown-server README.md
 
 This will start a server serving in the current directory and all child directories and open a browser (on a mac) showing README.md converted to html. If you navigate to a directory name only child directories and .md files are shown in a directory listing. If there is a README.md file in that directory it will be appended to the directory listing.
 
+If you are deep down inside a git repository and you want to serve the whole repository (so that relative links will work) then this command will do that for you.
+
+```shell
+github-markdown-server -d $(git rev-parse --show-toplevel) somefile.md
+```
+
 ## Contrib
 
 There is a [contrib](contrib/) directory with an emacs lisp file which will start a server and open a file for you. It'll keep track of which servers it has started and reuse an existing server if a file you want to preview is under that server's serving directory.
 
-There is also a small python script (called `p`) which will work with files and produce paths and urls.
-
 ## Contributing
 
 Please feel free to send me pull requests! This is my first Ruby project and it always feels like my first time when I write Emacs Lisp.

data/contrib/github-markdown-server.el

@@ -9,11 +9,14 @@
 
 (defvar github-markdown-servers '() "The servers we have running.")
 (defvar github-markdown-server-port 7494 "The next available server port.")
+(defvar github-markdown-server-browser "Google Chrome" "Application to use with osx's open -a to open files.")
 
 (defun git-base (&optional file-name)
   "Get the base of a git repository for FILE-NAME (or the current buffer)."
   (interactive (buffer-file-name))
-  (shell-command-to-string (concat "p -t -g " (shell-quote-argument buffer-file-name))))
+  (shell-command-to-string
+    (concat "git -C " (shell-quote-argument (directory-file-name file-name))
+      " rev-parse --show-toplevel 2>/dev/null")))
 
 (defun github-markdown-serve  (&optional file-name)
   "Get the base of a git repository for FILE-NAME (or the current buffer)."
@@ -44,18 +47,26 @@
                   (substring file-name (length (car server))))))))
         (progn
           (if server
-            (progn (message (concat "re-starting server on port " (number-to-string (cdr server)))))
+            (message (concat "re-starting github-markdown-server on port:" (number-to-string (cdr server))))
             (progn
-              (message "starting server"))
-              (setq server (cons base github-markdown-server-port))
-              ))
-          (call-process-shell-command (concat "github-markdown-server"
-                                        " --directory=" (shell-quote-argument (car server))
-                                        " --port=" (number-to-string (cdr server))
-                                        " " (shell-quote-argument file-name)) nil 0)
+              ;; find the next available port
+              (while (< 0 (length (shell-command-to-string
+                       (concat "lsof -n -i4TCP:" (number-to-string github-markdown-server-port) " | grep LISTEN"))))
+                (setq github-markdown-server-port (+ github-markdown-server-port 1)))
+
+              (message (concat "starting github-markdown-server on port:" (number-to-string (cdr server))))
+              (setq server (cons base github-markdown-server-port))))
+          (call-process-shell-command
+            (concat "github-markdown-server"
+              " --directory=" (shell-quote-argument (car server))
+              " --port=" (number-to-string (cdr server))
+              " " (shell-quote-argument file-name))
+            nil 0)
           (if (not server)
-            (progn (add-to-list 'github-markdown-servers server)
-              (setq github-markdown-server-port (+ github-markdown-server-port 1))))))))
+            (progn
+              (add-to-list 'github-markdown-servers server)
+              (setq github-markdown-server-port (+ github-markdown-server-port 1))))))
+      (message ""))))
 
 (defun view-file-in-browser (&optional file-name)
   "Open up file on github or via a local markdown server.
@@ -65,9 +76,17 @@ Prefix arg \[universal-argument] to not run local server."
   (if (and (not current-prefix-arg) (string-match "\.md$" file-name))
     (github-markdown-serve file-name)
     (call-process-shell-command
-      (concat "open "
-        (shell-quote-argument
-          (shell-command-to-string (concat "p -u -t " (shell-quote-argument file-name))))) nil 0)))
+      (concat "open -a " (shell-quote-argument github-markdown-server-browser) " \"$("
+        "perl -e 'use File::Basename; $f = shift @ARGV; $d = dirname($f); $b = basename($f); "
+        "$o = `git -C $d config --get remote.origin.url`; "
+        "if ($o =~ qr(!git(@|://)github.com[:/]!)) { "
+        "  $o =~ s!git(@|://)github.com[:/](.*).git$!https://github.com/$2!; "
+        "} else { $o = \"\" }"
+        "$p = `git -C $d rev-parse --show-prefix`; "
+        "chomp($o, $p); "
+        "if ($o) { print \"$o/blob/master/$p$b\n\"; } else { print \"file://$f\" }' "
+        (shell-quote-argument (buffer-file-name)) ")\"")
+    nil 0)))
 
 (provide 'github-markdown-server)
 ;;; github-markdown-server ends here

data/github-markdown-server.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.version     = GithubMarkdownServer::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Alex K (wtwf.com)']
-  s.email       = 'ruby@mail.wtwf.com'
+  s.email       = 'wtwf.com'
   s.homepage    = 'https://github.com/arkarkark/github-markdown-server'
   s.summary     = %q{Use your favorite editor to edit a markdown file, Run the server and open the file. Saving in your editor updates instantly in the browser.}
   s.description = %q{Runs a webserver to preview Github markdown with live.js updating.}

data/lib/github-markdown-server/version.rb

@@ -1,3 +1,3 @@
 module GithubMarkdownServer
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-markdown-server
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex K (wtwf.com)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-28 00:00:00.000000000 Z
+date: 2014-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markdown-preview
@@ -73,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.3'
 description: Runs a webserver to preview Github markdown with live.js updating.
-email: ruby@mail.wtwf.com
+email: wtwf.com
 executables:
 - github-markdown-server
 extensions: []
@@ -84,7 +84,6 @@ files:
 - README.md
 - bin/github-markdown-server
 - contrib/github-markdown-server.el
-- contrib/p
 - data/image/favicon.ico
 - data/js/live.js
 - github-markdown-server.gemspec

data/contrib/p

@@ -1,116 +0,0 @@
-#!/usr/bin/python
-# Created by: Alex K (wtwf.com)Tue Dec  7 16:50:41 2004
-# Last Modified: Time-stamp: <Thu Nov 27 03:08:53 PST 2014>
-
-"""
-Turn a path into an absolute path or url.
-
--g, --git print out the root directory of this git repository
--h, --help print out this message
--p, --path show a full absolute path to the file
--t, --trim do not append a newline to the file
--u, --url show a url to the file (https://github.com/... or file:///)
--s, --server show a utl to a local github-markdown-server
---port use this port for github-markdown-server url (default 7474)
---host use this host for github-markdown-server url (default localhost)
-"""
-
-__author__ = 'wtwf.com (Alex K)'
-
-import getopt
-import logging
-import os
-import re
-import sys
-
-def Usage(code, msg=''):
-  """Show a usage message."""
-  if code:
-    fd = sys.stderr
-  else:
-    fd = sys.stdout
-  PROGRAM = os.path.basename(sys.argv[0]) # pylint: disable=invalid-name,unused-variable
-  print >> fd, __doc__ % locals()
-  if msg:
-    print >> fd, msg
-  sys.exit(code)
-
-def Main():
-  """Run."""
-  logging.basicConfig()
-  logging.getLogger().setLevel(logging.DEBUG)
-  try:
-    opts, args = getopt.getopt(sys.argv[1:], 'ghpstu',
-                               'git,help,host=,path,port=,server,trim,url'.split(','))
-  except getopt.error, msg:
-    Usage(1, msg)
-
-  if not args:
-    Usage(1)
-
-  output = 'path'
-  trim = False
-  port = 7474
-  host = 'localhost'
-  for opt, arg in opts:
-    if opt in ('-g', '--git'):
-      output = 'git'
-    if opt in ('-h', '--help'):
-      Usage(0)
-    if opt in ('--host',):
-      host = arg
-    if opt in ('-p', '--path'):
-      output = 'path'
-    if opt in ('--port',):
-      port = int(arg)
-    if opt in ('-s', '--server'):
-      output = 'github-markdown-server'
-    if opt in ('-t', '--trim'):
-      trim = True
-    if opt in ('-u', '--url'):
-      output = 'url'
-
-  for arg in args:
-    arg = os.path.abspath(arg)
-    if output != 'path':
-      arg = ConvertToUrl(arg, output, port, host)
-    if trim:
-      sys.stdout.write(arg)  # for python 3 we could do print(arg, end='',flush=True)
-    else:
-      print arg
-
-def ConvertToUrl(arg, output, port, host):
-  """Try to turn this into a url."""
-  directory = arg
-  base_url = None
-  while directory != '/' and not base_url:
-    directory = os.path.dirname(directory)
-    config_filename = os.path.join(directory, '.git', 'config')
-    if os.path.exists(config_filename):
-      if output == 'git':
-        return directory
-      for line in open(config_filename):
-        match = re.search(r'url = git@github.com:(.*)\.git', line)
-        if match:
-          base_url = 'https://github.com/%s/blob/master/' % match.group(1)
-          break
-
-  if output == 'git':
-    return ''
-  if output == 'github-markdown-server':
-    if base_url:
-      basename = arg[len(directory) + 1:]
-      arg = 'http://%s:%d/%s' % (host, port, basename)
-    else:
-      basename = os.path.basename(arg)
-      arg = 'http://%s:%d/%s' % (host, port, basename)
-  else:
-    if base_url:
-      arg = base_url + arg[len(directory) + 1:]
-    else:
-      arg = 'file://' + arg
-
-  return arg
-
-if __name__ == '__main__':
-  Main()