https://github.com/czfadmin/bookmarks

vscode bookmark
https://github.com/czfadmin/bookmarks

bookmarks vscode

Last synced: 10 months ago
JSON representation

vscode bookmark

• Host: GitHub
• URL: https://github.com/czfadmin/bookmarks
• Owner: czfadmin
• License: mit
• Created: 2023-09-20T15:40:18.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-02-22T09:01:13.000Z (over 1 year ago)
• Last Synced: 2025-04-02T09:51:10.445Z (about 1 year ago)
• Topics: bookmarks, vscode
• Language: TypeScript
• Homepage:
• Size: 21.4 MB
• Stars: 6
• Watchers: 0
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README-ZN.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Bookmark Manager

![GitHub Release Date](https://img.shields.io/github/release-date/czfadmin/bookmarks?logo=github)

![GitHub last commit](https://img.shields.io/github/last-commit/czfadmin/bookmarks?logo=github)

![Visual Studio Marketplace Last Updated](https://img.shields.io/visual-studio-marketplace/last-updated/czfadmin.bookmark-manager?logo=visualstudiocode&logoColor=blue)

- [中文](./README-ZN.md)

## Features

- Toggle line bookmark

- Toggle bookmark with selection

- Customize bookmark style and text decorator color

- Bookmark management view

- Quickly jump to preview bookmarks

- Customized bookmark notes

- Group customization

- Customize icons using [iconify](https://iconify.design/)  🎉

### Preview

- Overview

![overview](resources/overview.gif)

- Sidebar bookmark management

![tree-view](images/badge.png)

- Various colors available

![various-colors](images/colors.png)

![choose color](images/choose-color.png)

- The floating prompt displays bookmark information

![float-prompt](images/prompt.png)

- Display an overview list of bookmarks

![file-overview](images/file-overview.png)

- Group customization

![Group customization](images/group.png)

- Menus

![menu](images/menus.png)

- Customize icons using [iconify](https://iconify.design/)  🎉

![icons](images/icons.png)

## Configuration

- `bookmark-manager.alwaysUseDefaultColor`: Always use the default color to decorate the bookmark icon.

- `bookmark-manager.showGutterInOverviewRuler`: Whether to display the `Gutter` icon on the overview ruler.

- `bookmark-manager.showTextDecoration`: Set whether to display the bookmark's text decorator.

- `bookmark-manager.showGutterIcon`: Whether to display the `gutter` icon.

- `bookmark-manager.fontWeight`: Bookmark font style.

- `bookmark-manager.colors`: built-in colors and user-defined bookmark colors.

- `bookmark-manager.defaultBookmarkIconColor`: Set the default bookmark color.

- `bookmark-manager.showBorder`: whether to display the border.

- `bookmark-manager.border`: Bookmark border style.

- `bookmark-manager.showOutline`: whether to display the outline of the bookmark.

- `bookmark-manager.outline`: bookmark outline style.

- `bookmark-manager.wholeLine`: Whether to select the entire line, by default the area with content is selected.

- `bookmark-manager.textDecorationLine`: Customize the decorator style of bookmarks.

- `bookmark-manager.textDecorationStyle`: Customize the decorator style of bookmarks.

- `bookmark-manager.outlitextDecorationThicknessne`: Customize the thickness of the decoration.

- `bookmark-manager.lineBlame`: Enable `lineBlame` for bookmarks.

- `bookmark-manager.enableClick`: Enable click to jump to bookmark location.

- ......

### Commands

- `bookmark-manager.toggleLineBookmark`: Toggle line bookmark.

- `bookmark-manager.toggleLineBookmarkWithLabel`: Toggle line bookmark with label.

- `bookmark-manager.toggleLineBookmarkWithColor`: Toggle line bookmark with color.

- `bookmark-manager.toggleBookmarkWithSelection`: Toggle Bookmark with selection.

- `bookmark-manager.editDescription`: Editing the description of a bookmark.

- `bookmark-manager.clearAllBookmarksInCurrentFile`: Clear all bookmark in opened file.

- `bookmark-manager.changeBookmarkColor`: Change the color of the selected bookmark.

- `bookmark-manager.clearAllBookmarks`: Clear all bookmarks.

- `bookmark-manager.deleteBookmark`: Delete selected bookmark.

- `bookmark-manager.editLabel`: Edit the label of the selected bookmark.

- `bookmark-manager.gotoSourceLocation`: Jump to the location of the bookmark.

- `bookmark-manager.quickJumpTo`: Quick jump.

- `bookmark-manager.openInEditor`: Open in editor. **WIP**

- `bookmark-manager.listBookmarksInCurrentFile`: List bookmarks in current file.

- ....

## Attention

- After adding a bookmark to a line or selected area, if `bookmark-manager.showGutterIcon` is turned on, you will not be able to set a breakpoint directly. However, you can create one by right-clicking on the line number. For more details [VSCode issus# 5923](https://github.com/Microsoft/vscode/issues/5923)

- ⚒️ Note that there is currently a problem of abnormal bookmark information when the code is refactored.

  **Enjoy!**

## Contributors

[![All Contributors](https://img.shields.io/github/all-contributors/czfadmin/bookmarks?color=ee8449&style=flat-square)](#contributors)