Skip to content

muleyuck/jikan.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

unit-test Software License Release

jikan.nvim

Your Neovim start screen, replaced by a clock.

jikan.nvim shows the current time when you open Neovim without a file. No configuration, no clutter — just the time.

demo

Features

  • Braille art clock shown automatically on startup
  • Blinking colon for a live feel
  • Clock color auto-detected from your colorscheme background
  • Horizontally and vertically centered in any window size
  • Skipped automatically when opening a file (nvim file.txt)
  • Zero configuration required

Requirements

  • Neovim >= 0.9

Installation

lazy.nvim

{
  'muleyuck/jikan.nvim',
  lazy = false,
  opts = {},
}

vim-plug

Plug 'muleyuck/jikan.nvim'

Then in your init.lua:

require('jikan').setup()

packer.nvim

use {
  'muleyuck/jikan.nvim',
  config = function()
    require('jikan').setup()
  end,
}

mini.deps

MiniDeps.add('muleyuck/jikan.nvim')
require('jikan').setup()

Manual

cd ~/.config/nvim/pack/plugins/start
git clone https://github.com/muleyuck/jikan.nvim

Then in your init.lua:

require('jikan').setup()

Configuration

No configuration is required. If you want to customize, the following options are available:

require('jikan').setup({
  -- Font for the braille art. Built-in: 'Inter' (default), 'Digital'
  font = 'Inter',

  -- Fixed foreground color for the clock (e.g. '#AED6F1').
  -- When nil, the color is auto-detected from the colorscheme background.
  color = nil,
})

Highlights

jikan.nvim defines one highlight group:

Group Used for
JikanClock Clock foreground

The color is set automatically — light on dark backgrounds, dark on light backgrounds. To override:

vim.api.nvim_set_hl(0, 'JikanClock', { fg = '#your-color' })

Or pass color in setup() to fix it permanently.

LICENSE

The MIT License

About

Braille art clock on your Neovim start screen.

Topics

Resources

License

Stars

Watchers

Forks

Contributors