Skip to content

sez11a/VimStar

Repository files navigation

Welcome to VimStar!

This is a NeoVim distribution optimized for writing. Key shortcuts (using Space instead of Ctrl) are a homage to WordStar.

Documentation

For comprehensive documentation, visit the VimStar Site or check out the site/ directory.

Quick Guide:

  1. Press Space in normal mode to see the menu.

  2. There are WordStar-like key bindings with helpful menus. Instead, however, of the Ctrl key, they're prefixed with Space instead, to avoid collision with Vim keys (such as Ctrl-o). See Space-k, Space-o, Space-q, and Space-g.

  3. Plugins are downloaded automatically via Lazy, and should be downloaded automatically after installing.

  4. Configuration is symlinked, so you can try VimStar and then easily go back to your own configuration (have a look at the install script).

Installation

The installation scripts

  • Clone/update VimStar to ~\.VimStar
  • On Linux, symlink the ~/.VimStar to ~/.config/nvim
  • On Windows, copy the configuration to %LOCALAPPDATA%\nvim, create required directories, and set up user config template

Note: You must have Git installed and available in your PATH. Also, take note that I used AI to generate the Windows script, and it hasn't been tested as far as I know.

Linux/macOS

Execute this at the CLI:

curl -sLf https://raw.githubusercontent.com/sez11a/VimStar/master/install-vimstar.sh | bash

Windows

Execute this in PowerShell:

Set-ExecutionPolicy Bypass -Scope Process -Force
irm https://raw.githubusercontent.com/sez11a/VimStar/master/install-vimstar.ps1 | iex

Screenshots

VimStar starts with a most recently used files list.

Markdown files are the default format in VimStar.

That's all for now. Enjoy!

About

Vim distribution optimized for writing, inspired by WordStar.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors