{"id":31980119,"url":"https://github.com/majjoha/marginalia.nvim","last_synced_at":"2025-10-14T23:27:28.103Z","repository":{"id":318740410,"uuid":"1061083694","full_name":"majjoha/marginalia.nvim","owner":"majjoha","description":"Lightweight Neovim plugin for writing and managing notes. ","archived":false,"fork":false,"pushed_at":"2025-10-13T13:25:46.000Z","size":31,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-14T20:35:27.126Z","etag":null,"topics":["lua","neovim","neovim-plugin","nvim","plugin"],"latest_commit_sha":null,"homepage":"https://github.com/majjoha/marginalia.nvim?tab=readme-ov-file","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/majjoha.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-21T07:49:25.000Z","updated_at":"2025-10-14T16:41:56.000Z","dependencies_parsed_at":"2025-10-14T20:35:29.085Z","dependency_job_id":"9d6e3210-c348-4883-8a59-d92625321e7e","html_url":"https://github.com/majjoha/marginalia.nvim","commit_stats":null,"previous_names":["majjoha/marginalia.nvim"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/majjoha/marginalia.nvim","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majjoha%2Fmarginalia.nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majjoha%2Fmarginalia.nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majjoha%2Fmarginalia.nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majjoha%2Fmarginalia.nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/majjoha","download_url":"https://codeload.github.com/majjoha/marginalia.nvim/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majjoha%2Fmarginalia.nvim/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279024814,"owners_count":26087842,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lua","neovim","neovim-plugin","nvim","plugin"],"created_at":"2025-10-14T23:27:27.183Z","updated_at":"2025-10-14T23:27:28.097Z","avatar_url":"https://github.com/majjoha.png","language":"Lua","readme":"# Marginalia\n![CI](https://github.com/majjoha/marginalia.nvim/actions/workflows/ci.yml/badge.svg)\n\nMarginalia is a lightweight plugin for writing and managing notes. It aims to be\na good, unobtrusive Neovim citizen, and it relies on built-in functionality,\ne.g., `:grep` and \u003ckbd\u003egf\u003c/kbd\u003e, does not introduce changes to the `filetype` of\nyour notes, or shadow your existing key bindings.\n\nThe plugin supports creating and editing notes, listing all your notes, finding\nbacklinks, and searching your notes by tags.\n\n## Features\n- Create and edit notes\n- List all notes in the quickfix list\n- Find backlinks automatically\n- Tag-based search with completion\n- Works with built-in Neovim functionality (`:grep`, \u003ckbd\u003egf\u003c/kbd\u003e, etc.)\n- Zero external dependencies\n\n## Installation\n```sh\ngit clone https://github.com/majjoha/marginalia.nvim.git ~/.config/nvim/pack/packages/start/marginalia.nvim\n```\n\n## Setup\n```lua\nrequire(\"marginalia\").setup()\n```\n\nTo override the default configuration:\n```lua\nrequire(\"marginalia\").setup({\n  notes_path = \"~/notes\", -- Path to your notes folder\n  file_extension = \".md\", -- The default extension for your notes\n  header_format = \"# \", -- The header format for your notes, e.g., # Header\n  tag_identifier = \"#\", -- The identifier used for tags, e.g., #tag\n  file_prefix_function = function() -- The prefix function used when\n    return os.date(\"%Y%m%d%H%M-\")   -- creating new notes\n  end\n})\n```\n\n## Commands\n| Command                         | Arguments      | Description                                                                 |\n|---------------------------------|----------------|-----------------------------------------------------------------------------|\n| `:MarginaliaNew`                | `{title}`      | Creates a new note with the given title.                                    |\n| `:MarginaliaEdit`               | `{title}`      | Edits the note with the given title. This command supports tab completion.  |\n| `:MarginaliaList`               | –              | Lists all notes.                                                            |\n| `:MarginaliaFindBacklinks`      | –              | Finds references to the current note.                                       |\n| `:MarginaliaFindTagReferences`  | `[{tag}]`      | Finds references to the given tag or the tag under the cursor if not given. |\n| `:MarginaliaConvertWordToTag`   | –              | Converts the word under the cursor to a tag.                                |\n\n## Suggested key mappings\n```lua\nvim.keymap.set(\"n\", \"\u003cLeader\u003emnn\", \":MarginaliaNew\u003cSpace\u003e\")\nvim.keymap.set(\"n\", \"\u003cLeader\u003emen\", \":MarginaliaEdit\u003cSpace\u003e\")\nvim.keymap.set(\"n\", \"\u003cLeader\u003emln\", \":MarginaliaList\u003cCR\u003e\", { silent = true })\nvim.keymap.set(\"n\", \"\u003cLeader\u003emfb\", \":MarginaliaFindBacklinks\u003cCR\u003e\",\n  { silent = true })\nvim.keymap.set(\"n\", \"\u003cLeader\u003emft\", \":MarginaliaFindTagReferences\u003cSpace\u003e\", {})\nvim.keymap.set(\"n\", \"\u003cLeader\u003emcw\", \":MarginaliaConvertWordToTag\u003cCR\u003e\",\n  { silent = true })\n```\n\n## FAQ\n### How can I use folders for storing my notes?\nYou can define a prefix function that returns an empty string when you\nconfigure the plugin:\n\n```lua\nrequire(\"marginalia\").setup({\n  file_prefix_function = function()\n    return \"\"\n  end,\n})\n```\n\nNow when you run `:MarginaliaNew technology/neovim`, a new note with the name\n`neovim` is stored in your `technology` folder.\n\nIf you want to use folders, you might want to consider adding this `autocmd` to\nensure that nested folders are created automatically:\n\n```lua\nvim.api.nvim_create_autocmd(\"BufWritePre\", {\n  pattern = \"*\",\n  callback = function()\n    local dir = vim.fn.expand(\"\u003cafile\u003e:p:h\")\n    if vim.fn.isdirectory(dir) == 0 then\n      vim.fn.mkdir(dir, \"p\")\n    end\n  end,\n})\n```\n\n### Can I use wiki-style links?\nYes. In fact, this behavior can be enabled anywhere in Neovim. For notes in\nMarkdown format, simply add\n\n```lua\nvim.opt.suffixesadd:append({ \".md\" })\n```\n\nto your `init.lua`, and you can now visit links, e.g.,\n`[[today-i-learned-neovim]]`, using \u003ckbd\u003egf\u003c/kbd\u003e.\n\n## Development\nRun tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim):\n\n```sh\nnvim --headless -c \"PlenaryBustedDirectory tests/\" -c \"qa\"\n```\n\n## Related projects\n- [vim-notes](https://github.com/xolox/vim-notes)\n- [vim-pad](https://github.com/fmoralesc/vim-pad)\n- [VimWiki](https://github.com/vimwiki/vimwiki)\n- [Waikiki](https://github.com/fcpg/vim-waikiki)\n- [wiki.vim](https://github.com/lervag/wiki.vim)\n\n## License\nSee [LICENSE](./LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajjoha%2Fmarginalia.nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmajjoha%2Fmarginalia.nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajjoha%2Fmarginalia.nvim/lists"}