Nothing Special   »   [go: up one dir, main page]

Skip to content
/ word.lua Public

the (eventually) infinitely extensible markdown note-taking work environment that you can have in Neovim without having to ever leave the comfort of markdown.

License

Notifications You must be signed in to change notification settings

clpi/word.lua

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

word - the familiar, organized future for neovim

Neovim License LuaRocks


Warning

word.lua is BEGINNING DEVELOPMENT

Introduction

  • word.lua is a [neovim] plugin intended to bring the extensibility of [org-mode] or [neorg] in the comfort of [markdown].

  • we want to be able to take notes like developers, without shutting ourselves out of the entire ecosystem built around markdown.

  • it's a work in progress with an initial project structure based on the structure of neorg, and will be updated regularly

Requirements

[!Info]

word.lua must have at least neovim 0.10+

Quickstart

lazy.nvim
{
    "clpi/word.lua",
    lazy    = false,
    config  = true,
    version = "*"
    branch  = "master",
    config  = true,
    build   = ":TSUpdate markdown markdown_inline",
    dependencies = {
      "nvim-telescope/telescope.nvim",
      "MunifTanjim/nui.nvim",
      "nvim-neotest/nvim-nio",
      "pysan3/pathlib.nvim",
      "nvim-lua/plenary-nvim",
    }
}

plug.vim

[!Warning]

Not yet tested

Plug "nvim-telescope/telescope.nvim"
Plug 'MunifTanjim/nui.nvim'
Plug 'nvim-lua/plenary-nvim'
Plug "pysan3/pathlib.nvim"
Plug "nvim-neotest/nvim-nio"
Plug "clpi/word.lua", {
    \ "branch" : "master",
    \ "do"     : ":lua require('word').setup()"
    \ }

Vundle

[!Warning]

Not yet tested

Plugin 'nvim-lua/plenary-nvim'
Plugin "pysan3/pathlib.nvim"
Plugin "nvim-neotest/nvim-nio"
Plugin 'nvim-telescope/telescope.nvim'
Plugin 'MunifTanjim/nui.nvim'
Plugin 'clpi/word.lua'

dein.vim

[!Warning]

Not yet tested

call dein#add('pysan3/pathlib.nvim')
call dein#add('nvim-neotest/nvim-nio')
call dein#add('MunifTanjim/nui.nvim')
call dein#add('nvim-telescope/telescope.nvim')
call dein#add('clpi/word.lua')

packer.nvim

[!Warning]

Not yet tested

use {
  "clp/word.lua",
  requires = {
        "nvim-telescope/telescope.nvim",
        "nvim-nio",
        "nui.nvim",
        "plenary.nvim",
        "pathlib.nvim"
  },
  tag = "*",
  config = function()
      require("word").setup()
  end,
}

mini.deps

[!Warning]

Not yet tested

{
  "clp/word.lua",
}

rocks.nvim

[!Warning]

Not yet tested

Rocks install mini.lua

Config

-- Setup the initial configuration
require("word").setup({})

Usage

Check back!

Todo

Tip

Check out TODO.md for a more detailed list of tasks

Support

check back!

Credits

word.lua is a project by clpi and is licensed under the MIT license. For information about contributing, please consult the CONTRIBUTING.md file.

special thanks goes to nvim-neorg/neorg for providing the inspiration and basis of this project.

thank you and keep updated!

(back to top)