Skip to content

🧑🏼‍💻Plugin for learning and practicing touch-typing right in the Neovim editor

License

Notifications You must be signed in to change notification settings

ydkulks/speedster.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

speedster.nvim

Code Size license Lua Neovim

Plugin to warm-up and practice typing skill and speed

🪧 Demo

Usage

SpeedsterDemo

📌 Layout

  • Help menu at top left corner
  • Time at top right corner
  • Display in the middle
  • Prompt at the bottom

SpeedsterLayout

🎨 Themes

Dark Mode

SpeedsterDarkTheme

Light Mode

SpeedsterLightTheme

⬇️ Installation

Plug 'ydkulks/speedster.nvim'
use {
  'ydkulks/speedster.nvim',
  config=function()
    local config = require('speedster.config')
    config.setup({
      num_char = 80,
      symbols = 2,
      dark_theme = {
        Title = 'guifg=LightGrey ctermfg=7',
        Text = 'guifg=#afafaf ctermfg=145',
        Hr = 'guifg=LightGrey ctermfg=7',
        Border = 'guifg=LightGrey ctermfg=7'
      },
    })
  }
-- Lazy.nvim uses vim-plug.
-- Follow vim-plug config instruction above

🆘 Help

:help speedster.nvim

⚙️ Configuration

Refer :help speedster_config help docs for updated guide on configuration

-- init.lua
require("speedster.config").setup({
    -- Default values
    num_char = 50,     -- Number of characters displayed
    symbols = 1,       -- Number of words replaced with symbols
    dark_theme = {     -- Dark theme
      Title = 'guifg=LightGrey ctermfg=7',
      Text = 'guifg=#afafaf ctermfg=145',
      Hr = 'guifg=LightGrey ctermfg=7',
      Border = 'guifg=LightGrey ctermfg=7'
    },
    light_theme = {    -- Light theme
      Title = 'guifg=#000000 ctermfg=16',
      Text = 'guifg=#000000 ctermfg=16',
      Hr = 'guifg=#000000 ctermfg=16',
      Border = 'guifg=#3b4048 ctermfg=238'
    }
})

📄 TODO

  • Themes
  • Config option to customize settings
  • Test compatibility with other plugin managers

🐛 Known Bugs & Limitation

  • Not able to disable some plugins in prompt buffer that affects typing