README section on similar projects

[tuurep]

It's always great when READMEs have links to the most prominent alternatives, maybe with comparisons.

Alternatives:

• https://github.com/iamcco/markdown-preview.nvim
  • unmaintained
• https://github.com/brianhuster/live-preview.nvim
• https://github.com/toppair/peek.nvim
• https://github.com/instant-markdown/vim-instant-markdown
• https://github.com/wallpants/github-preview.nvim
• https://github.com/yusukebe/gh-markdown-preview
• https://github.com/euclio/vim-markdown-composer

LSP approach:

• https://github.com/euclio/mdpls
  • inspired: https://github.com/mhersson/mpls

[tuurep]

Interesting relic of history:

https://github.com/junegunn/vim-xmark

But this shouldn't be added 😄

[tuurep]

Similar design to Vivify (standalone shell command with Vim plugin):

• https://github.com/shime/livedown
  • looks unmaintained?
  • possibly Vim-only

Some alternatives with only the shell command:

• https://github.com/ianks/octodown
• https://github.com/yoshuawuyts/vmd
  • looks unmaintained?
• https://github.com/yuanchuan/markdown-preview
  • archived
• https://github.com/joeyespo/grip

[tuurep]

Plan: probably include the ones that are actively used and maintained (from the opening post)

But I think iamcco/markdown-preview.nvim should be mentioned because it's the most famous markdown-preview plugin by far, in my view -- then mention that it's unmaintained. Not mentioning it would be tonedeaf in a sense :)

[jannis-baum]

Some ideas for columns to include in the table (not in this order):

• works in shell, (n)vim, or all of them
• customizability (style/css, function/client-side js, both, or none)
• light/dark mode (no vs. yes-manual vs. yes-automatic)
• support of full
  • basic markdown
  • extended markdown
  • GitHub markdown?
• list of additional markdown features
• supports local file links
  • also the file browser?
• supported OSs
• has active development/maintenance
• should we mention Jupyter Notebook support here?

[tuurep]

should we mention Jupyter Notebook support here?

Maybe we can have a note about the file listing and jupyter -capabilities after the table, unless there's any other that can do one of these

[tuurep]

Found more alternatives:

• https://github.com/davidgranstrom/nvim-markdown-preview
• https://github.com/ms-jpq/markdown-live-preview
  • has https://github.com/GnikDroy/mdpreview.nvim as a wrapper for nvim
• https://github.com/cnshsliu/smp.nvim

An alternative to gh-markdown-preview:

• https://github.com/thiagokokada/gh-gfm-preview
  • provides capability to work offline

An alternative to grip:

• https://github.com/chrishrb/go-grip

  • Unlike grip, this tool doesn't rely on the GitHub API. Instead, it parses Markdown files locally.

I believe what we have here is more than enough exhaustive. Next I'm gonna test each and every one and make notes on them, then condense that into a table.

[tuurep]

Update: this got stuck because it's too overwhelming to find out how to install each project on a specific Linux distro, and then know everything about each project

We have to start small by just making a simple list of the most prominent/useful alternatives (just name and link)

Will get to it at some point