search

artempyanykh / marksman

Write Markdown with code assist and intelligence in the comfort of your favourite editor.
MIT License
1.94k stars 35 forks source link

Update info in README about out-of-the box support in Vim #330

Closed waldyrious closed 3 hours ago

waldyrious commented 3 weeks ago

The README currently says:

  • Vim:

    • via ale - will support Marksman out-of-the-box once PR is merged; in the meantime...

      Example config (add the following to your ~/.vim/after/ftplugin/markdown.vim):

      if exists('g:loaded_ale')
call ale#linter#Define('markdown', { 'name': 'marksman', 'lsp': 'stdio', 'executable': 'marksman', 'command': '%e server', 'initialization_options': {} })
end

Since the mentioned PR https://github.com/dense-analysis/ale/pull/4565 has been merged, shouldn't this section of the README be updated?

artempyanykh commented 2 weeks ago

Thanks for raising this @waldyrious! I'd be happy to accept README fixes in a PR :)

waldyrious commented 2 weeks ago

I'd be happy to submit a PR, but as I'm not a Vim user, I'm not really sure what it should say instead :sweat_smile: — can it just be as follows?

  • Vim:
    • via ale - supports Marksman out-of-the-box

I noticed that a new version of ale has not yet been released with that change, so I'm not sure this is really accurate :thinking:

artempyanykh commented 3 hours ago

@waldyrious ack! Perhaps this is for the future then. I'll close the issue for now.