Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clpi/word.lua
the (eventually) infinitely extensible markdown note-taking homstead and (soon to be) extraordinarly powerful work environment that you can have in Neovim without having to ever leave the comfort of the plain markup gold standard, markdown.
https://github.com/clpi/word.lua
automation journal markdown md neovim neovim-plugin notebook notes notion nvim nvim-plugin obsidian org org-mode tracker vim vim-plugin vimwiki wiki zettelkasten
Last synced: about 1 month ago
JSON representation
the (eventually) infinitely extensible markdown note-taking homstead and (soon to be) extraordinarly powerful work environment that you can have in Neovim without having to ever leave the comfort of the plain markup gold standard, markdown.
- Host: GitHub
- URL: https://github.com/clpi/word.lua
- Owner: clpi
- License: mit
- Created: 2024-11-16T04:42:19.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-11-16T21:41:51.000Z (about 1 month ago)
- Last Synced: 2024-11-16T22:24:02.140Z (about 1 month ago)
- Topics: automation, journal, markdown, md, neovim, neovim-plugin, notebook, notes, notion, nvim, nvim-plugin, obsidian, org, org-mode, tracker, vim, vim-plugin, vimwiki, wiki, zettelkasten
- Language: Lua
- Homepage: http://word.cli.st/
- Size: 319 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# word - the _familiar_, organized future for neovim
[](https://github.com/clpi/word.lua/actions/workflows/luarocks.yml)
[](https://github.com/clpi/word.lua/actions/workflows/book.yml)
---
`for only neovim currently, not vim`
`for neovim 0.10+`
## Introduction
- **word** is a plugin meant to bring the awesome extensibility of emacs [org-mode] or [neorg] without needing to switch from the gold standard [markdown], or from the best editor [neovim].
- 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
- [neovim 0.10+](https://neovim.io)
## Install
### lazy.nvim
```lua
{
"clpi/word.lua",
lazy = false,
version = false,
config = true,
opts = {},
}
```
---
### plug.vim
```vim
Plug "clpi/word.lua", {
\ "branch" : "main",
\ "do" : ":lua require('word').setup()"
\ }
```
---
### packer.nvim
```lua
use {
"clp",
rocks = {
"nvim-nio",
"nui.nvim",
"plenary.nvim",
"pathlib.nvim"
},
tag = "*",
config = function()
require("word").setup()
end,
}
```
## Config
check back!
## Usage
check back!
## Todo
- [ ] Bring at least a few scaffolded modules to functionality
- [ ] Automate flake creation through GH Actions
- [ ] Fix rudimentary commands ported over to bring to base functionality
- [ ] Once at base functionality, clean up and refactor to bring to a `0.1.0` release
- [ ] Allow optional choice of telescope or not
- [ ] Add other package manager support
## Support
check back!
## Credits
`word.lua` is a project by [clpi](github.com/clpi) and is licensed under the [MIT](./LICENSE) license.
thank you and keep updated!
- [The word book](https://word.cli.st)
- [word.lua on luarocks](https://luarocks.org/inits/clpi/word.lua)
- [word.lua on dotfyle](https://dotfyle.com/plugins/clpi/word.lua)