There is error when pressing the shortcut "ctrl+shift+g"

[tjliupeng]

Hi,

when I install this package, open an MD file, and press "ctrl+shift+g", get the error below at console:

error: Error in GitHubMarkdownPreview package:

''

What happens?

I use sublime Text 3.

[dotcypress]

Which OS do you use?

[tjliupeng]

I use windows 10. If need logs, where can I find the log files?

[fadelm0]

It happens with me as well. Using sublime 3 build 3126 on windows 7 x64.

Tried both installing from package control and manually, as instructed on the main page.

The page renders fine in the browser, aside from a few characters that are not displayed correctly, such as the ' apostrophe and — em dash (but I don't know if it's related to this issue).

The error reads:

Error in GitHubMarkdownPreview package: [WinError 2] The system cannot find the file specified.

[vladdeSV]

Can confirm I have this issue too.

Windows 10 64-bit. Sublime Text 3, 3126

[SteveVacasa]

For what's it's worth, I'm pretty sure the problem is that the package assumes the markdown file exists in a git repo.

[zigmd]

Doesn't work on Sublime Text (build 3211) on macOS

[0xdevalias]

Potentially related:

• https://github.com/dotcypress/GitHubMarkdownPreview/issues/30
• https://github.com/dotcypress/GitHubMarkdownPreview/issues/32

[0xdevalias]

The error I hit is while editing a document, that hasn't been saved to a file, and thus also isn't going to be part of a GitHub repo:

Error in GitHubMarkdownPreview package:

'NoneType' object has no attribute 'rfind'

Using Sublime Text (build 4143) on macOS Ventura

---

For what's it's worth, I'm pretty sure the problem is that the package assumes the markdown file exists in a git repo.

Exploring how this addon works, for my own benefit, but also to help others figure out where there errors may be occuring/why..

The command is defined here, and calls the github_markdown_preview function in the code: https://github.com/dotcypress/GitHubMarkdownPreview/blob/bafa0df006d05750f06614049953cd78b54e93c3/Default.sublime-commands#L3-L4

github_markdown_preview_command:

• tries to get the repoName with repoName = get_github_repo_name(self.view.file_name())
• which is later used to generate the html of the preview with html = generate_preview(self.view.substr(selection), repoName)
• this html is then written to a temporary file (temp_file = tempfile.NamedTemporaryFile(delete=False, suffix='.html')), and opened in the web browser (webbrowser.open("file://" + temp_file.name))

https://github.com/dotcypress/GitHubMarkdownPreview/blob/bafa0df006d05750f06614049953cd78b54e93c3/GHMarkdownPreview.py#L64-L82

get_github_repo_name will return None if the filename is None; otherwise it will call git to try and parse the repo name from the git remote, when it's using HTTPS (not SSH):

https://github.com/dotcypress/GitHubMarkdownPreview/blob/bafa0df006d05750f06614049953cd78b54e93c3/GHMarkdownPreview.py#L36-L49

generate_preview:

• calls the https://api.github.com/markdown API (either with urllib2, or curl when on linux (because "The python package included with sublime text for Linux is missing the ssl module (for technical reasons)")
  • Given this API endpoint requires an auth token, and none appears to be provided in this code, I don't think this is ever going to work anyway
  • it puts the git repo_name in the context field of the json body sent to the /markdown API

  • The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

• returns the response, which appears to be a string containing the HTML from rendering the provided markdown

https://github.com/dotcypress/GitHubMarkdownPreview/blob/bafa0df006d05750f06614049953cd78b54e93c3/GHMarkdownPreview.py#L51-L62

The docs for GitHub's /markdown API endpoint are at:

• https://docs.github.com/en/rest/markdown?apiVersion=2022-11-28#render-a-markdown-document

[0xdevalias]

If you wanted to achieve similar to this, here is a hacky little command line script you could use, that will read the markdown from the clipboard (with pbpaste, so only works on macOS), calls the API using the gh CLI tool, encodes the html response in a data:// url, then opens that url in Chrome:

markdown=$(pbpaste)
output=$(gh api --method POST -H "Accept: application/vnd.github+json" /markdown -f text="$markdown")
base64_output=$(echo "$output" | base64)
data_url="data:text/html;base64,$base64_output"

echo data_url
open -a "Google Chrome" "$data_url"

It looks like there is already a gh extension written by @itspriddle that basically does the same thing (though doesn't encode it in a data:// URL nor open it in Chrome to preview:

• https://josh.fail/2022/gh-render-markdown-extension/
• https://github.com/itspriddle/gh-render-markdown