Skip to content

Commit

Permalink
fixing links, adjusting name
Browse files Browse the repository at this point in the history
  • Loading branch information
clpi committed Jan 18, 2025
1 parent 3673710 commit 0f237ed
Show file tree
Hide file tree
Showing 17 changed files with 67 additions and 67 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# down.lua
# down.nvim

the _familiar_, organized future for neovim and beyond!

<a href="https://neovim.io"> ![Neovim](https://img.shields.io/badge/Neovim%200.10+-brightgreen?style=for-the-badge) </a>
<a href="./LICENSE"> ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)</a>
![LuaRocks](https://img.shields.io/luarocks/v/clpi/down.lua)
![LuaRocks](https://img.shields.io/luarocks/v/clpi/down.nvim)

---

> [!Caution]
>
> `down.lua` is currently in **early** *ongoing* development.
> `down.nvim` is currently in **early** *ongoing* development.
<!--toc:start-->

Expand All @@ -27,9 +27,9 @@ the _familiar_, organized future for neovim and beyond!

## Introduction

- `down.lua` is a [neovim](#) plugin intended to bring the extensibility of [org-mode](#) or [neorg](github.com/nvim-neorg/neorg) with the **comfort** of [markdown](#).
- `down.nvim` is a [neovim](#) plugin intended to bring the extensibility of [org-mode](#) or [neorg](github.com/nvim-neorg/neorg) with the **comfort** of [markdown](#).

- In its [current state](#), `down.lua` is in the beginning stages of development, currently functionining as a markdown-based version of [neorg](#), with many planned features to come
- In its [current state](#), `down.nvim` is in the beginning stages of development, currently functionining as a markdown-based version of [neorg](#), with many planned features to come

- we want to be able to take notes like developers, without leaving behind all the ecosystem benefits of markdown.

Expand All @@ -39,7 +39,7 @@ the _familiar_, organized future for neovim and beyond!

> [!Note]
>
> `down.lua` must have at least [neovim 0.10+](https://neovim.io)
> `down.nvim` must have at least [neovim 0.10+](https://neovim.io)
## Quickstart

Expand All @@ -51,7 +51,7 @@ the _familiar_, organized future for neovim and beyond!
```lua
-- Place in lazy.nvim spec
{
"clpi/down.lua",
"clpi/down.nvim",
opts = {
workspace = {
default = "notes",
Expand Down Expand Up @@ -87,12 +87,12 @@ the _familiar_, organized future for neovim and beyond!
> Not yet tested
```vim
Plug "nvim-telescope/telescope.nvim"
Plug "nvim-telescope/telescope.nvim" " optional
Plug "nvim-treesitter/treesitter.nvim"
Plug "nvim-lua/plenary.nvim",
Plug "MunifTanjim/nui.nvim",
Plug "pysan3/pathlib.nvim"
Plug "clpi/down.lua", {
Plug "clpi/down.nvim", {
\ "branch" : "master",
\ "do" : ':lua require([[down]]).setup({
\ workspace = {
Expand Down Expand Up @@ -122,7 +122,7 @@ Plugin "pysan3/pathlib.nvim"
Plugin 'nvim-telescope/telescope.nvim'
Plugin "nvim-lua/plenary.nvim",
Plugin "MunifTanjim/nui.nvim",
Plugin 'clpi/down.lua'
Plugin 'clpi/down.nvim'
```

</details>
Expand All @@ -144,7 +144,7 @@ call dein#add("nvim-lua/plenary.nvim")
call dein#add("MunifTanjim/nui.nvim")
call dein#add('pysan3/pathlib.nvim')
call dein#add('nvim-telescope/telescope.nvim')
call dein#add('clpi/down.lua')
call dein#add('clpi/down.nvim')
```

</details>
Expand All @@ -163,7 +163,7 @@ call dein#add('clpi/down.lua')
```lua
use {
"clp/down.lua",
"clp/down.nvim",
requires = {
"nvim-telescope/telescope.nvim",
"nvim-lua/plenary.nvim",
Expand Down Expand Up @@ -202,7 +202,7 @@ use {
```lua
{
"clp/down.lua",
"clp/down.nvim",
}
```

Expand Down Expand Up @@ -268,18 +268,18 @@ require("down").setup({ ---@type down.mod.Config
## Credits

`down.lua` is a project by [clpi](github.com/clpi) and is licensed under the [MIT](./LICENSE) license. For information about **contributing**, please consult the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
`down.nvim` is a project by [clpi](github.com/clpi) and is licensed under the [MIT](./LICENSE) license. For information about **contributing**, please consult the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

special thanks goes to [nvim-neorg/neorg](https://github.com/nvim-neorg/neorg) for providing the inspiration and basis of this project.

---

thank you and keep updated!

- [The `down.lua` book](https://down.cli.st)
- [The `down.lua` wiki](https://github.com/clpi/down.lua/wiki)
- [`down.lua` on luarocks](https://luarocks.org/inits/clpi/down.lua)
- [`down.lua` on dotfyle](https://dotfyle.com/plugins/clpi/down.lua)
- [The `down.nvim` book](https://down.cli.st)
- [The `down.nvim` wiki](https://github.com/clpi/down.nvim/wiki)
- [`down.nvim` on luarocks](https://luarocks.org/inits/clpi/down.nvim)
- [`down.nvim` on dotfyle](https://dotfyle.com/plugins/clpi/down.nvim)

<!-- <div align="center"> -->
<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand Down
2 changes: 1 addition & 1 deletion assets/snippets/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# down.lua snippets
# down.nvim snippets
2 changes: 1 addition & 1 deletion assets/template/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# down.lua templates
# down.nvim templates
8 changes: 4 additions & 4 deletions book/book.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[book]
title = "The down.lua book"
description = "Goes over the down.lua extension for neovim"
title = "The down.nvim book"
description = "Goes over the down.nvim extension for neovim"
authors = ["Chris Pecunies"]
language = "en"
multilingual = false
Expand All @@ -27,8 +27,8 @@ copy-fonts = true
# additional-js = "book.js"
smart-punctuation = true
no-section-label = false
git-repository-url = 'github.com/clpi/down.lua'
edit-url-template = "https://github.com/clpi/down.lua/edit/master/book/{path}"
git-repository-url = 'github.com/clpi/down.nvim'
edit-url-template = "https://github.com/clpi/down.nvim/edit/master/book/{path}"
git-repository-icon = "fa-github"
input-404 = "404.md"

Expand Down
6 changes: 3 additions & 3 deletions book/lua/module/examples/barebones.lua
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ end

---@brief One such piece of data you may wish to store is the ongoing collection of cells, as well
---@brief as their contents and type in the Juypyter notebook. You may even wish to leverage the
---@brief down.lua `lsp.notebook` module to hook into the LSP for Jupyter notebooks.
---@brief down.nvim `lsp.notebook` module to hook into the LSP for Jupyter notebooks.
J.cells = {}

---@brief To keep track of the notebook currently being interacted with
Expand All @@ -63,7 +63,7 @@ J.notebook = {
kernel = 'python3',
}

---@brief Technically, we have now created a proper module that can be loaded into Neovim through down.lua.
---@brief Technically, we have now created a proper module that can be loaded into Neovim through down.nvim.
---@brief However, we will be typically be best off at the beginning characterizing the module with any
---@brief setup, dependencies, configuration, commands, and even keymaps you believe it may one day need.

Expand Down Expand Up @@ -110,5 +110,5 @@ J.config = {
---@brief whether builtin or custom-made by the community.
---
---@brief Regardless, I hope this has provided a good starting point to help you to take the very first steps
---@brief in creating an awesome module to extend and bless the down.lua ecosystem. Good luck and godspeed!
---@brief in creating an awesome module to extend and bless the down.nvim ecosystem. Good luck and godspeed!
return J
2 changes: 1 addition & 1 deletion book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Summary

Welcome -- to the `down.lua` book. I hope this helps!
Welcome -- to the `down.nvim` book. I hope this helps!

- [Intro](./intro.md)
- [About](./about/index.md)
Expand Down
2 changes: 1 addition & 1 deletion book/src/about/philosophy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## Why?

I started `down.lua` primarily due to my conflicting captivation and frustration with existing solutions like [org-mode](#) and, more recently in the burgeoning `Neovim` ecosystem, [neorg](https://github.com/nvim-neorg/neorg).
I started `down.nvim` primarily due to my conflicting captivation and frustration with existing solutions like [org-mode](#) and, more recently in the burgeoning `Neovim` ecosystem, [neorg](https://github.com/nvim-neorg/neorg).
2 changes: 1 addition & 1 deletion book/src/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `down.lua` Book Index
# `down.nvim` Book Index

## About

Expand Down
12 changes: 6 additions & 6 deletions book/src/intro.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# down.lua
# down.nvim

## Intro

`down.lua` is a simple ORM for Lua. It is designed to be simple to use and
`down.nvim` is a simple ORM for Lua. It is designed to be simple to use and

## Is it for you?

Expand All @@ -14,7 +14,7 @@

## Other resources

- [GitHub](https://github.com/clpi/down.lua)
- [Sourcehut](https://git.sr.ht/~clpi/down.lua)
- [Luarocks](https://luarocks.org/modules/clpi/down.lua)
- [Dotfyle](https://dotfyle.com/plugins/clpi/down.lua)
- [GitHub](https://github.com/clpi/down.nvim)
- [Sourcehut](https://git.sr.ht/~clpi/down.nvim)
- [Luarocks](https://luarocks.org/modules/clpi/down.nvim)
- [Dotfyle](https://dotfyle.com/plugins/clpi/down.nvim)
6 changes: 3 additions & 3 deletions book/src/modules/builtin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Here is the full guide to all the modules, which I intend to keep largely perminantely in this arrangement so far as I can muster, and so far as it provides a good experience for everyone.

I will also not be changing the names to any of the modules, switching them around willy-nilly, etc., and especially not changing the name of the project, which is `down.lua`, after its most recent overhaul.
I will also not be changing the names to any of the modules, switching them around willy-nilly, etc., and especially not changing the name of the project, which is `down.nvim`, after its most recent overhaul.

This is a project in its extremely early days, so perhaps I may be laying this down too soon and without any real consequence, but I believe that the system, naming, etc. has congealed to the point where I can
safely believe in the foundations it has laid.
Expand All @@ -17,10 +17,10 @@ safely believe in the foundations it has laid.

## The primary core modules are

Below, you will find a list of the primary **root** core modules builtin to `down.lua`. There are a few things beyond the obvious that should be stated first:
Below, you will find a list of the primary **root** core modules builtin to `down.nvim`. There are a few things beyond the obvious that should be stated first:

1. While I have intended for all modules to be useful in their own right in a context not involving internal use, I do have to note that, like all things, there is a certain variance with regards how accessible a given builtin module is, as well as how much use it may serve to you.
To that end, I have tried to begin scaffolding a per-module README.md that should (at some point) provide any others contributing or building on top of `down.lua` what they may and may not get out of the builtin modules here.
To that end, I have tried to begin scaffolding a per-module README.md that should (at some point) provide any others contributing or building on top of `down.nvim` what they may and may not get out of the builtin modules here.

2. The hierarchy of modules presented here is very important to understand, both with regards its structure and its purpose. This becomes especially important when considering the control flow of the setup process, both for the plugin as a whole and indeed to a lesser degree for
the individual modules themselves. It can be easy to at first get lost in the weeds here, but I don't believe it is something that should hinder those exploring the codebase very long at all.
Expand Down
6 changes: 3 additions & 3 deletions book/src/modules/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ end

---@brief One such piece of data you may wish to store is the ongoing collection of cells, as well
---@brief as their contents and type in the Juypyter notebook. You may even wish to leverage the
---@brief down.lua `lsp.notebook` module to hook into the LSP for Jupyter notebooks.
---@brief down.nvim `lsp.notebook` module to hook into the LSP for Jupyter notebooks.
J.cells = {

}
Expand All @@ -76,7 +76,7 @@ end
}


---@brief Technically, we have now created a proper module that can be loaded into Neovim through down.lua.
---@brief Technically, we have now created a proper module that can be loaded into Neovim through down.nvim.
---@brief However, we will be typically be best off at the beginning characterizing the module with any
---@brief setup, dependencies, configuration, commands, and even keymaps you believe it may one day need.

Expand Down Expand Up @@ -125,7 +125,7 @@ J.config = {
---@brief whether builtin or custom-made by the community.
---
---@brief Regardless, I hope this has provided a good starting point to help you to take the very first steps
---@brief in creating an awesome module to extend and bless the down.lua ecosystem. Good luck and godspeed!
---@brief in creating an awesome module to extend and bless the down.nvim ecosystem. Good luck and godspeed!
return J
```

Expand Down
2 changes: 1 addition & 1 deletion down-scm-1.rockspec
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ rockspec_format = '3.0'
version = MODREV .. SPECREV
branch = 'master'
tag = 'v0.1.1-alpha'
package_name = 'down.lua'
package_name = 'down.nvim'
github_url = 'https://github.com/' .. maintainer .. '/' .. package_name .. '.git'
github_wiki_url = 'https://github.com/' .. maintainer .. '/' .. package_name .. '/wiki'
github_issues_url = 'https://github.com/' .. maintainer .. '/' .. package_name .. '/issues'
Expand Down
4 changes: 2 additions & 2 deletions lua/down.lua
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---@author clpi
---@file down.lua 0.1.0
---@file down.nvim 0.1.0
---@license MIT
---@package down.lua
---@package down.nvim
---@brief neovim note-taking plugin with the
---@brief comfort of mmarkdown and the power of org

Expand Down
2 changes: 1 addition & 1 deletion lua/down/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ end
---@todo TODO: Setup configuration and parse user config
---@todo in this config module only

--- The down.lua configuration
--- The down.nvim configuration
--- @class down.Config
local Config = {
--- Start in dev mode
Expand Down
2 changes: 1 addition & 1 deletion lua/down/health.lua
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ H.check_req = function()
end

H.check = function()
h.start 'down.lua'
h.start 'down.nvim'
H.check_optional()
H.check_req()
H.user()
Expand Down
34 changes: 17 additions & 17 deletions lua/down/mod/link/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Link.setup = function()
return { ---@type down.mod.Setup
loaded = tsu_ok,
dependencies = {
'cmd', --- For commands
'data.history', --- For history storage
'cmd', --- For commands
'data.history', --- For history storage
'tool.treesitter', --- For treesitter node parsing
'workspace', --- For checking filetype and index file names of current workspace
'workspace', --- For checking filetype and index file names of current workspace
},
}
end
Expand All @@ -36,18 +36,18 @@ Link.maps = {
'<ESC>:<C-U>lua require("down.mod.link").follow.link()<CR>',
{ desc = 'Follow link', silent = true, noremap = false, nowait = true },
},
{
'n',
'<S-TAB>',
'<ESC>:<C-U>lua require("down.mod.link").goto_prev_link()<CR>',
{ desc = 'Previous link', silent = true, noremap = false, nowait = true },
},
{
'n',
'<TAB>',
'<ESC>:<C-U>lua require("down.mod.link").goto_next_link()<CR>',
{ desc = 'Next link', silent = true, noremap = false, nowait = true },
},
-- {
-- 'n',
-- '<S-TAB>',
-- '<ESC>:<C-U>lua require("down.mod.link").goto_prev_link()<CR>',
-- { desc = 'Previous link', silent = true, noremap = false, nowait = true },
-- },
-- {
-- 'n',
-- '<TAB>',
-- '<ESC>:<C-U>lua require("down.mod.link").goto_next_link()<CR>',
-- { desc = 'Next link', silent = true, noremap = false, nowait = true },
-- },
}

Link.commands = {
Expand Down Expand Up @@ -211,12 +211,12 @@ end
Link.ref = function(node)
local link_label = Link.text(node)
for _, captures, _ in
Link.dep['tool.treesitter'].query([[
Link.dep['tool.treesitter'].query([[
(link_reference_definition
(link_label) @label (#eq? @label "]] .. link_label .. [[")
(link_destination) @link_destination
)]]),
'markdown'
'markdown'
do
local capture = ts.get_node_text(captures[2], 0)
return capture:gsub('[<>]', '')
Expand Down
6 changes: 3 additions & 3 deletions scripts/bin/down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Down = {}
--+ | down v0.1.1-alpha | +--
--+ | | +--
--+ | ABOUT | +--
--+ | down (down.lua) is a dev-focused note-taking | +--
--+ | down (down.nvim) is a dev-focused note-taking | +--
--+ | environment for markdown, in development. | +--
--+ | | +--
--+ | USAGE | +--
Expand Down Expand Up @@ -47,7 +47,7 @@ local wts_ok, wts = pcall(require, 'down.mod.integration.treesitter')

--+ +---------------------+ extern +---------------------+ +--
--+ | | +--
--+ | import the down lua dependencies. | +--
--+ | import the down.nvim dependencies. | +--
--+ | | +--
--+ +----------------------------------------------------+ +--

Expand Down Expand Up @@ -122,7 +122,7 @@ local down = {
return pre .. ' ' .. h .. ' '
end,
version = 'v0.1.0-alpha.2',
repo = 'github.com/clpi/down.lua',
repo = 'github.com/clpi/down.nvim',
home = 'down.cli.st',
updated = '2024-12-15',
color = true,
Expand Down

0 comments on commit 0f237ed

Please sign in to comment.