https://github.com/spywhere/vscode-mark-jump

Jump to the marked section in the code
https://github.com/spywhere/vscode-mark-jump

vscode vscode-extension

Last synced: 15 days ago
JSON representation

Jump to the marked section in the code

• Host: GitHub
• URL: https://github.com/spywhere/vscode-mark-jump
• Owner: spywhere
• Created: 2016-11-30T17:14:10.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T17:30:20.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T12:30:22.558Z (7 months ago)
• Topics: vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 312 KB
• Stars: 29
• Watchers: 6
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Mark Jump

[![Version](https://vsmarketplacebadge.apphb.com/version/spywhere.mark-jump.svg)](https://marketplace.visualstudio.com/items?itemName=spywhere.mark-jump)

[![Installs](https://vsmarketplacebadge.apphb.com/installs/spywhere.mark-jump.svg)](https://marketplace.visualstudio.com/items?itemName=spywhere.mark-jump)

Jump to the marked section in the code

![Screenshot](images/screenshot.png)

### What is Mark Jump?

Mark Jump is simply an extension that let you jump across your marking points in the code.

### How to use it?

Simply install the extension, Mark Jump should show the mark count in the status bar!

Use arrow keys to jump between them, click to jump to it.

You can also use the following key bindings to jump through various type of marks...

- `Ctrl+Alt+P` / `Ctrl+Cmd+P` (`markJump.jumpToProjectMarks`): Jump to all marks in the project

- `Ctrl+Alt+M` / `Ctrl+Cmd+M` (`markJump.jumpToMarks`): Jump to all marks (either in current editor or a whole project)

- `Ctrl+Alt+S` / `Ctrl+Cmd+S` (`markJump.jumpToEditorMarks.section`): Jump to all section marks (in current editor)

- `Ctrl+Alt+T` / `Ctrl+Cmd+T` (`markJump.jumpToEditorMarks.todo`): Jump to all TODOs (in current editor)

- `Ctrl+Alt+N` / `Ctrl+Cmd+N` (`markJump.jumpToEditorMarks.note`): Jump to all Notes (in current editor)

- `Ctrl+Alt+,` / `Ctrl+Cmd+,` (`markJump.jumpToPreviousMark`): Jump to previous mark (in current editor)

- `Ctrl+Alt+.` / `Ctrl+Cmd+.` (`markJump.jumpToNextMark`): Jump to next mark (in current editor)

### How to write the marks?

Just simply write one of these syntax in your code, Mark Jump will found it right away!

You can also add more syntax via the configurations (pull requests are welcomed).

#### Section Marks

- `// MARK: Section name`

- `# pragma Section name` (case sensitive)

#### TODOs

- `// TODO: Text goes here`

- `// TODO(writer name): Text goes here`

#### Notes

- `// NOTE: Text goes here`

- `// NOTE(writer name): Text goes here`

#### Mark Filter

You can custom how "Jump to previous/next mark" jump by use a specific command instead of general one.

- To filter only "Section" mark, add `.section` after a command name.

- To filter only "To Do" mark, add `.todo` after a command name.

- To filter only "Note" mark, add `.note` after a command name.