Both gh markdown-preview --reload gh markdown-preview -r are not working.

I'm using Ubuntu with WSL, it wasn't working on Firefox on Windows. I opened the Linux version but that didn't work either. I also tried Edge and nothing.

I'm editing my README.md inside Vim. I don't expect live changes but I expected changes everytime I save changes.

This is not an issue.

It's more of a thank you and a rudimentary emacs usage as I found this extension much more helpfull than using pandoc with emacs markdown mode on *nix like systems. I use this on Ubuntu 20.04.3 LTS and GNU Emacs 26.3.

Feel free to comment or just close this issue as you see fit.

To use this gh extension with emacs:

1. insert into the .emacs file (or equivalent):

(defun md_preview ()
  "start /usr/bin/gh markdown-preview -p PORT <current buffer file>"
  (interactive)
  (let (PORT BFN BFN_PORT)
    (setq PORT (read-string "PORT: " nil nil "3333"))  
    (setq BFN (buffer-file-name))
    (setq BFN_PORT (concat BFN ":" PORT))
    (start-process "gh_markdown_preview" BFN_PORT "/usr/bin/gh" "markdown-preview" "-p" PORT BFN)))

(global-set-key [(control ?x) (p)] 'md_preview)

2. restart emacs and open a couple of markdown files.
3. to preview a buffer with a markdown file by using a web browser and the url http://localhost:3333: in emacs "C-x p" RET (to use the default port 3333)
4. to preview a second buffer with a different markdown file in a web browser and the url http://localhost:3334: in emacs "C-x p" 3334 RET (or any port that isn't in use such as 3333 in this example)
5. the lisp code above will put output from the gh markdown-preview instances into separate buffers named like /path/to/markdown-file.md:3333, /path/to/different-markdown-file.md:3334, etc. in emacs
6. close the /path/to/markdown-file.md:3333 emacs buffer to exit the preview processes on port 3333 (and free the port)

This emacs implementation has shortcomings: A. The user must keep track of what port is open and available for use B. I'm not sure if this is the best solution if one is editing several hundred md files. I only edit a handful so I suspect it will work just fine for that. C. While I've used emacs for some time, the above is a first attempt at coding lisp. It works for me but there are likely many more shortcomings than A & B above. Treat this a place to start, not an end point.

HTH

and thanks again - it's really handy.

EDITs - the original code posted didn't work. The code above does, is a bit simpler, and perhaps makes it easier to keep track of what markdown file is being displayed on what port.

I'm on current Arch Linux with the current version of gh and this extension. On start, it outputs:

$ gh markdown-preview README.md
2022/04/07 15:27:37 Accepting connections at http://*:3333/
2022/04/07 15:27:37 Open http://*:3333/ on your browser
2022/04/07 15:27:37 GET [200] /
2022/04/07 15:27:37 Watching README.md for changes
2022/04/07 15:27:37 GET [404] /favicon.ico
2022/04/07 15:27:38 GET [200] /__/md

All other similar utilities (i.e grip for a specific example) that create a local web-server output a valid click-able URL in the terminal which you can just click on to conveniently jump to in your browser. I know the browser is automatically opened the first time but you may want to open it a second/later time. So please change that http://*:3333/ to http://localhost:3333/.

I suspect you may want to argue that http://*:3333/ informs the user that the port is opened globally but, as possibly another issue, I suggest from a security/privacy standpoint that the port should only be opened locally (i.e. on localhost) by default anyhow. Add another option -g/--global and thus for the rare case when a user needs this he obviously already knows what URL to use.

I've previously used grip but it has some annoying failures (currently broken with a Python error on Arch Linux) so I am looking for an alternative.

The user can specify the hostname the server will bind with a --host option. The default value is localhost.

Usage:

$ gh markdown-preview --host 192.168.3.3

Outputs:

2022/04/07 18:29:49 Accepting connections at http://192.168.3.3:3333/
2022/04/07 18:29:49 Open http://192.168.3.3:3333/ on your browser

If locahost is set, you can't access it from the other global address.

If the markdown file specified by the command line does not exist, "gh-markdown-preview" should not open a browser. Now, it will open automatically.

Currently, the "gh-markdown-preview" starts and prints Open http://* on your browser, although markdown file is not specified in the current directory and REAMDE.md does not exist. CLI should throw "Not Found" error.

With --reload option, error has been happened.

2021/12/02 04:19:52 Change detected in README.md, refreshing
2021/12/02 04:19:52 Change detected in README.md, refreshing
2021/12/02 04:19:52 error:websocket: close sent

When gh-markdown-preview creates anchor tags it adds "user-content-" to the id.

For example, if the user creates a markdown header called "My Anchor", gh-markdown-preview set the id to "user-content-my-anchor" instead of "my-anchor".

See the GitHub docs and this article for an explanation of #gh-dark-mode-only and #gh-light-mode-only.

You can use this repo of mine, which uses this feature, to test this functionality if you'd like.

Here is what my repo looks like in gh-markdown-preview:

And here is what it looks like rendered on GitHub:

Sometimes you just want to render a markdown file directly to a HTML file. grip provides an option to do this:

grip --export README.html

For this case, no server is started, no browser tab is opened, etc. Also can specify '-' for stdout.

Can this option please be added here?

>gh  markdown-preview test.md
--: C:\Users\lenovo\AppData\Local\GitHub CLI\extensions\gh-markdown-preview\gh-markdown-preview: /usr/bin/env: bad interpreter: Permission denied

In most cases, there is no favicon.ico in our directory and it will be 404 not found. How about preparing the default favicon.ico and showing it as /favicon.ico.