docs: revise install section #1090
Conversation
SylvanFranklin
requested review from
Myriad-Dreamin and
Enter-tainer
as code owners
docs/tinymist/frontend/neovim.typ
Outdated
| formatterMode = "typstyle" | ||
| ``` | ||
| == Preview | ||
| There is work in progress to integrate #link("https://github.com/chomosuke/typst-preview.nvim")[typst-preview.nvim] directly into `tinymist`. In the meantime you can find can find installation and configuration instructions on that repo. This should be a shortterm solution. |
There was a problem hiding this comment.
I believe we have introduced an announcement here that we will provide some plugin developed inside of tinymist repository, while we were only providing a sample plugin to integrate tinymist into LazyVim. I have a few questions:
- What's the position of the new plugin? Does it only replace the typst-preview.nvim?
- How do the replaced plugin authors think of it? Is it common or supported in (neo)vim community? Will they join or against to build an out-of-box new typst.nvim? We must at least discuss about it with chomosuke.
There was a problem hiding this comment.
If we could, imo we should push patches or changes to existing plugins to not force people to leave their old settings but still get benefit from our work.
There was a problem hiding this comment.
Yes I agree that sounds good. I was wondering at the status of all of that, good to know progress is underway. I am not sure on how that integration will work I was assuming you had some deal what that plugin author. To me it makes sense to not have an external preview tool when there is potential for the lsp to have that feature, but I think the whole issue requires discussion.
|
btw, don't we need to pin the main file any more for tinymist in neovim? It seems that part is completely removed? |
I'm honestly not sure since currently the builtin preview does not work for me which is the main conflict when changing files. Using typst-preview.nvim I'm getting no issues because it is being handled under the hood for you. That project has everything we need to make tinymist integrate with neovim, but I'm still confused on the status of merging it. It says in the readme that it is a plugin for tinymist, and it uses tinymist itself under the hood. Bottom line is tinymist has to either copy everything over and merge that plugin, or just direct people to use it with a link. Most neovim LSP does hot have a preview builtin, LaTeX and markdown both have separate plugins, so it's not a huge deal to have these as different projects, it is a little weird though that the lsp has preview capability and we're bringing in another tool. As long as everything works and the docs are clear on it I don't think it's a huge problem. |
|
I am not talking about preview. |
| - With `lspconfig`: | ||
| ```lua | ||
| require("lspconfig")["tinymist"].setup { | ||
| settings = { |
There was a problem hiding this comment.
This part seems to be wrong for me. I think:
settings = {
...
}is enough, there should not be nested tinymist and settings inside?
There was a problem hiding this comment.
Yes you are right I had it different in my config so didn't notice
| ``` | ||
|
|
||
| There is also a plan to support multiple-file projects with a workspace configuration, but I don’t know whether it is Neovim’s way, so it needs further discussion. | ||
| == Preview | ||
|
|
There was a problem hiding this comment.
I am not sure if the pinMain part should be removed, as what I knew was that main file is more useful than just for preview, but I am sure that there won't be a workspace configuration anymore.
There was a problem hiding this comment.
I'm honestly not sure what people mean when they have problems with the pin main and multi files. Tinymist seems to work fine for me across different files no problem. We could ask someone who complained about it
There was a problem hiding this comment.
New issue regarding this: #1103
docs/tinymist/frontend/neovim.typ
Outdated
| == Feature Integration | ||
| - *LSP* (completion, definitions, etc.) | ||
| - *Folding Ranges* supported with #link("https://github.com/kevinhwang91/nvim-ufo")[ufo.] | ||
| - *Code Formatting* with #link("https://github.com/Enter-tainer/typstyle/")[typstyle] or #link("https://github.com/astrale-sharp/typstfmt")[typstfmt (deprecated).] |
There was a problem hiding this comment.
I am not sure, if it is so clear in this way, as folding ranges and code formatting are both parts of the standard lsp protocol. But it's not a real problem.
docs/tinymist/frontend/neovim.typ
Outdated
| #note-box[ | ||
| `tinymist.pinMain` is a stateful command, and tinymist doesn't remember it between sessions (closing and opening the editor). | ||
| ] | ||
| There is work in progress to integrate #link("https://github.com/chomosuke/typst-preview.nvim")[typst-preview.nvim] directly into `tinymist`. In the meantime you can find can find installation and configuration instructions on that repo. This should be a shortterm solution. |
There was a problem hiding this comment.
I have never seen such a work happening in tinymist repo, I think it is safe to just ask people to use typst-preview.nvim. Using tinymist alone for preview within neovim has never been the recommended way.
I added new instructions that are more up to date with neovim specs. There is still work to do to get all features working, and with the new addition of the typst-nvim preview some things will change in the future. I made a note saying that, but wanted to get this out soon because of the confusion from people in issues and in the discord.