(Ready Access Markdown)

---

Two notes:

• global one note, everywhere
• project one note per project root

Install

lazy.nvim

{
  "sektant1/ram.nvim",
  opts = {},
  keymaps = {
    global  = "<leader>rg",
    project = "<leader>rp",
  },
  cmd = { "RamGlobal", "RamProject" },
}

vim.pack (Neovim 0.12+)

vim.pack.add({ "https://github.com/sektant1/ram.nvim" })
require("ram").setup({})

Where files live

• global: ~/.local/share/nvim/ram/global.md (you can change it on setup)
• project: <project_root>/.ram.md

Project root = walk up cwd, find .git / package.json / Cargo.toml / pyproject.toml / go.mod / Makefile / CMakeLists.txt. None? Use cwd.

Config (defaults)

require("ram").setup({
  display = "float",  -- float | split | vsplit | tab
  ui = "auto",        -- auto | native | nui  (nui.nvim used if installed)
  -- border: string ("single"|"double"|"rounded"|"solid"|"shadow") or full nui border table:
  --   border = { style = "single", padding = { 1, 2 }, text = { top_align = "left" } }
  float = { width = 0.6, height = 0.7, border = "single", title = " RAM " },
  global_note_path = nil,
  project_note_filename = ".ram.md",
  project_root_markers = {
    ".git", ".hg", ".svn",
    "package.json", "Cargo.toml", "pyproject.toml", "go.mod",
    "Makefile", ".ram.md",
  },
  keymaps = {
    global  = false,  -- e.g. "<leader>rg"
    project = false,  -- e.g. "<leader>rp"
  },
  filetype = "markdown",
  autosave = true,
})

Any keymap = false to disable. project_root_markers = {} = strict cwd.

Commands

:RamGlobal :RamProject (both toggle)

Health

:checkhealth ram

License

MIT.