Giter Club home page Giter Club logo

todomon's Introduction

Todomon.nvim

Todomon.nvim is a lightweight Neovim plugin written in Lua, designed to manage to-do list items within your Neovim editor. With simple keystrokes, you can toggle to-do states and manage your tasks directly from the comfort of your Neovim environment.

Features

  • Toggle To-Do: Convert any line into a to-do item or toggle its completion state using a keyboard shortcut.
  • Keyboard Shortcut: Use Ctrl+Space to quickly toggle to-dos.

Installation

You can install todomon.nvim using your preferred package manager.

For vim-plug:

Plug 'your_username/todomon.nvim'

For packer.nvim:

use {'your_username/todomon.nvim'}

Usage

To toggle a to-do state, place the cursor on the line you want to modify and press Ctrl+Space. This will either:

Add [] to the beginning of the line, before any list marker such as -, *, etc., if it's not already a to-do item. Change [] to [x] to mark the to-do as completed, or back to [] if it's already completed. Configuration The plugin works out of the box with the default key mapping. If you wish to use a different key mapping, you can map your preferred key to the toggle_todo function in your Neovim configuration:

vim.api.nvim_set_keymap('n', '<YourKey>', '<cmd>lua toggle_todo()<CR>', { noremap = true, silent = true })

Contributing

Contributions are welcome! Feel free to fork the repository and submit pull requests.

License

This project is open-sourced under the MIT license.

todomon's People

Contributors

montagao avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.