Updates

All updates

Welcome to VimStar! Here’s what to do in your first 5 minutes.

1. Launch VimStar

nvim

Press e to start a new file or press f to open an existing file. If you want to open another file later, use Space-ko; if while you have a file open you want to start a new one, use Space-ke.

2. Write Something

  1. VimStar is still Neovim, so press i to begin writing in Markdown. Completion is on by default. To toggle it, hit Esc to go back to Normal mode and then press Space-oc.

  2. To preview your document, press Space-op.

  3. If you have Pandoc and LaTeX or Typst installed, press Space-p and the relevant command from the menu to produce a PDF in the same folder as your file.

  4. Use WordStar-inspired commands to save (Space-ks), save and exit (Space-kx), or abandon changes and exit (Space-kq).

3. Try the AI Assistant

  1. If you have Ollama installed, install a model you like.

  2. Edit ~/.VimStar/lua/vimstar-user.lua and set your model’s name in the vim.g.ollama_model variable.

  3. Save and exit VimStar, and then re-open it.

  4. Press Space-cc to chat. Type a prompt like “Explain the quicksort algorithm.”

4. Navigate Files

  • Space-ko to browse your file system
  • Space-fs = Find files in the current folder
  • Space-t = Toggle Neo-tree file explorer
  • Space-fp = Find git-tracked files only

5. Try the Wiki

  1. Customize the Wiki location in vimstar-user.lua by setting vim.g.wiki_root and then restarting VimStar.

  2. Space-ww opens the first Wiki page.

  3. Space-w-Space-w opens today’s journal page.

For more information, see the Wiki documentation by typing :help wiki.

6. Update VimStar

  1. To take advantage of new VimStar features, press Space-qu and then restart VimStar.

  2. To update your plugins, press Space-ql to launch the Lazy package manager.

  3. To update your LSPs and linters, press Space-qm to launch Mason.

  4. To update Tree-Sitter parsers, press Space-qt. It refreshes the parsers that are installed and builds the ones the files you have open still need.

Next Steps