{"id":30679542,"url":"https://github.com/nicksp/vscode-notelets","last_synced_at":"2025-10-13T18:43:10.458Z","repository":{"id":311512034,"uuid":"1043029931","full_name":"nicksp/vscode-notelets","owner":"nicksp","description":"Sticky notes for your codebase. Create and manage Markdown notes linked to source files in VS Code.","archived":false,"fork":false,"pushed_at":"2025-09-03T17:37:42.000Z","size":338,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-24T13:59:18.991Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=nicksp.notelets","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nicksp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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}},"created_at":"2025-08-23T02:18:13.000Z","updated_at":"2025-09-03T17:37:45.000Z","dependencies_parsed_at":"2025-08-25T01:34:40.854Z","dependency_job_id":"a3ef78c9-cd22-420b-bde6-53065837764c","html_url":"https://github.com/nicksp/vscode-notelets","commit_stats":null,"previous_names":["nicksp/vscode-notelets"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/nicksp/vscode-notelets","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksp%2Fvscode-notelets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksp%2Fvscode-notelets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksp%2Fvscode-notelets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksp%2Fvscode-notelets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nicksp","download_url":"https://codeload.github.com/nicksp/vscode-notelets/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksp%2Fvscode-notelets/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279016600,"owners_count":26085852,"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-13T02:00:06.723Z","response_time":61,"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":[],"created_at":"2025-09-01T14:12:42.673Z","updated_at":"2025-10-13T18:43:10.453Z","avatar_url":"https://github.com/nicksp.png","language":"TypeScript","funding_links":["https://buymeacoffee.com/plekhanov"],"categories":[],"sub_categories":[],"readme":"# Notelets\n\n\u003ca href=\"https://marketplace.visualstudio.com/items?itemName=nicksp.notelets\" target=\"__blank\"\u003e\u003cimg src=\"https://img.shields.io/visual-studio-marketplace/v/nicksp.notelets.svg?color=eee\u0026amp;label=VS%20Code%20Marketplace\u0026logo=visual-studio-code\" alt=\"Visual Studio Marketplace Version\" /\u003e\u003c/a\u003e \u003ca href=\"https://open-vsx.org/extension/nicksp/notelets\" target=\"__blank\"\u003e\u003cimg src=\"https://img.shields.io/open-vsx/v/nicksp/notelets?color=eee\u0026amp;label=Open%20VSX%20Registry\u0026logo=open-vsx\" alt=\"Open VSX Version\" /\u003e\u003c/a\u003e\n\nAdd sticky notes for your code — Markdown files alongside your project, organized by path.\n\n**Install from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=nicksp.notelets) or [Open VSX Registry](https://open-vsx.org/extension/nicksp/notelets).**\n\n![Notelets](screenshots/screenshot-1.png)\n\n## Features\n\n- Add a note for any non-Markdown file with a single command or click.\n- Notes are plain Markdown files stored under a configurable folder (defaults to `.vscode/notelets/`) mirroring your project structure.\n- Fast, minimal, zero distractions:\n  - CodeLens at the top of source files: \"Add Note\" / \"Open Note\".\n  - Optional status bar indicator showing if a note exists.\n  - Possibility to browse all notes in the workspace.\n- Smart behavior:\n  - Renaming a file renames its note.\n  - Deleting a file deletes its note.\n  - No notes for Markdown files or notes themselves (by design).\n- Almost zero config; sensible defaults.\n\n![Notelets with a tree view](screenshots/screenshot-2.png)\n\n![Notelets status bar icon](screenshots/statusbar-item.png)\n\n## Motivation\n\nI wanted a coherent workflow where lightweight documentation lives with the code it describes using the familiar convenience of Markdown:\n\n- Notes are plain Markdown inside your repo, version‑controlled with your code and reviewable.\n- The folder mirrors your project structure, so a note naturally “belongs” to a file and travels with it on rename/move.\n- No proprietary storage, no external sync, and works offline on any machine.\n- Collaboration is simple: commit, push, review, and share with the team like any other code change.\n- Minimal UI and zero lock‑in by design.\n\n\u003e [!TIP]\n\u003e To exclude notelets from version control, add `notelets.notesFolder` setting value to your `.gitignore`:\n\u003e\n\u003e ```shell\n\u003e .vscode/notelets/\n\u003e ```\n\n## Commands\n\n![Notelets commands](screenshots/commands.png)\n\nYou can run these commands from the Command Palette (\u003ckbd\u003eCmd\u003c/kbd\u003e+\u003ckbd\u003eShift\u003c/kbd\u003e+\u003ckbd\u003eP\u003c/kbd\u003e on a Mac, or \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eShift\u003c/kbd\u003e+\u003ckbd\u003eP\u003c/kbd\u003e on Windows).\n\n| Description           | Name                | Default Mac | Default Windows |\n| --------------------- | ------------------- | ----------- | --------------- |\n| Open or create a note | `notelets.openNote` | —           | —               |\n| Focus on notes view   |                     | —           | —               |\n\n\u003e [!TIP]\n\u003e [Bind a key](https://code.visualstudio.com/docs/configure/keybindings) to `notelets.openNote` for even faster access.\n\n## Settings\n\nYou can change the following options in the [Visual Studio Code settings](https://code.visualstudio.com/docs/configure/settings).\n\n| Description                                                | Setting                                                            | Default            |\n| ---------------------------------------------------------- | ------------------------------------------------------------------ | ------------------ |\n| Relative path to the root folder where Notelets are stored | [notelets.notesFolder](vscode://settings/notelets.notesFolder)     | `.vscode/notelets` |\n| How to open notes: editor or Markdown preview              | [notelets.openBehavior](vscode://settings/notelets.openBehavior)   | `editor`           |\n| Show a status bar item when a file has a Notelet           | [notelets.showStatusBar](vscode://settings/notelets.showStatusBar) | `true`             |\n\n## How It Works\n\n- For a file like `src/utils/math.ts`, its note will be created (by default) at:\n  - `.vscode/notelets/src/utils/math.ts.md`\n- Notes follow file renames and moves, and are removed when the source file is deleted.\n- Notes are not created for Markdown files or for note files themselves.\n\n## Changelog\n\nThe changelog can be found in [CHANGELOG.md](CHANGELOG.md).\n\n## You May Also Like\n\nCheck out my other Visual Studio Code extensions:\n\n- [Reveal on GitHub](https://marketplace.visualstudio.com/items?itemName=nicksp.reveal-on-github) — open the current project or file on GitHub\n- [Tidy Space](https://marketplace.visualstudio.com/items?itemName=nicksp.tidy-space) — keep your workspace clutter-free: only one sidebar at a time\n\n## Sponsoring\n\nThis project is maintained in my spare time. If this has been helpful to you, consider supporting its continued development and maintenance.\n\n\u003ca href=\"https://buymeacoffee.com/plekhanov\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/lato-yellow.png\" alt=\"Buy Me A Coffee\" height=\"51\" width=\"217\"\u003e\u003c/a\u003e\n\n## Contributing\n\nBug fixes are welcome, but not new features. Read our [contributing guidelines](CONTRIBUTING.md) to learn more.\n\n[Open an issue](https://github.com/nicksp/vscode-notelets/issues) on GitHub and [submit a pull request](https://github.com/nicksp/vscode-notelets/pulls).\n\n## Authors and License\n\n[Nick Plekhanov](https://plekhanov.me) and [contributors](https://github.com/nicksp/vscode-notelets/graphs/contributors).\n\n[Icon by Creative Squad](https://www.freepik.com/search).\n\n[MIT License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicksp%2Fvscode-notelets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnicksp%2Fvscode-notelets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicksp%2Fvscode-notelets/lists"}