Filetype plugin for forester, a tool for writing mathematical hypertext
This plugin is pre-alpha, expect breaking changes.
- Tree-sitter syntax highlighting Please report any issues with the grammar in the relevant repository
- following links and transclusions with
gf
- Searching for trees by title with telescope
- Creating new trees without leaving your editor
Available user commands:
Forester browse
: Telescope picker, search trees by title. TODO: support browsing by tag/taxon/...Forester new
: Create a new tree by specifying a prefixForester new_random
: Create a new tree with a random adress by specifying a prefixForester config
: Choose the config file from which to source the tree directoriesForester transclude_new
: transclude a new tree at cursor positionForester link_new
: link a new tree at cursor position
There is ongoing work on the Forester LSP, so I am not going to put effort into supporting completion in this plugin.
With lazy:
{
"kentookura/forester.nvim",
dependencies = {
{ "nvim-telescope/telescope.nvim" },
{ "nvim-treesitter/nvim-treesitter" },
{ "nvim-lua/plenary.nvim" },
{ "hrsh7th/nvim-cmp" },
},
},
You might need to run :TSInstall toml
and :TSInstall forester
.
In your forest.toml
(or any other config) you should add the list of
prefixes:
prefixes = ["foo", "bar"]
When calling :Forester new
, you will then be able to choose the prefix of the
new tree.
{
config = function()
local forester = require("forester")
vim.g.mapleader = " "
vim.keymap.set("n", "<leader>n.", "<cmd>Forester browse<CR>", { silent = true })
vim.keymap.set("n", "<leader>nn", "<cmd>Forester new<CR>", { silent = true })
vim.keymap.set("n", "<leader>nr", "<cmd>Forester new_random<CR>", { silent = true })
vim.keymap.set("i", "<C-t>", "<cmd>Forester transclude<CR>", { silent = true })
vim.keymap.set("i", "<C-l>", "<cmd>Forester link<CR>", { silent = true })
end,
}
require("nvim-web-devicons").setup({ override_by_extension = { ["tree"] = { icon = "๐ฒ" } } })
- Adding more telescope pickers and previewers, making use of the
forester query
commands - Link & transclude existing trees at cursor position.
- autocomplete
- ...