Skip to content

alpernae/NotesPlus

Repository files navigation

Notes+ Burp Suite Extension

Notes+ is a Burp Suite extension for fast Markdown note-taking during security testing. It combines an editor, preview, note library, and quality-of-life controls in one tab.

Highlights

  • Theme-aware UI with dark and light support in both saved-notes list and preview.
  • Search by title or full note content.
  • Pin notes, autosave changes, and export as Markdown or HTML.
  • Saved notes show Created and Updated timestamps.

Features

Note Management

  • Create, load, update, rename, and delete notes.
  • Persistent local storage as Markdown files.
  • Pin and unpin notes, with pinned state persisted across sessions.
  • Right-click context menu on saved notes for quick actions.
  • Saved notes list includes metadata row:
    • Updated: yyyy-MM-dd HH:mm
    • Created: yyyy-MM-dd HH:mm

Editor and Preview

  • Markdown editor with syntax highlighting for common elements.
  • Preview modes:
    • Live (auto-render while typing)
    • Manual (render on demand)
  • View modes:
    • Split
    • Editor only
    • Preview only
  • Adjustable preview font size.
  • Extended Markdown support through Flexmark extensions:
    • Tables
    • Task lists
    • Strikethrough
    • Autolinks
  • Secure preview behavior:
    • Raw HTML is suppressed
    • Markdown image tags are not rendered as images

Productivity

  • Autosave with configurable interval (5-300 seconds).
  • Export current note to Markdown or HTML.
  • Keyboard shortcuts:
    • Ctrl+S: Save note
    • Ctrl+N: New note
    • Ctrl+F: Focus search
  • Ready-to-use bug bounty template: BBTNT.md

Installation

Prerequisites

  • JDK 17 or newer.
  • Burp Suite Professional or Community.

Build

  1. Clone the repository.
  2. Build with Gradle Wrapper:
    • Windows: .\gradlew.bat build
    • Linux or macOS: ./gradlew build
  3. Built artifacts are created under build/libs.

Load in Burp Suite

  1. Open Burp Suite.
  2. Go to Extensions -> Installed -> Add.
  3. Select Extension type: Java.
  4. Choose the built artifact from build/libs.
  5. Finish the wizard. The NotesPlus tab appears in Burp.

Quick Start

  1. Open the NotesPlus tab.
  2. Click New and enter a note title.
  3. Write Markdown in the editor.
  4. Save the note.
  5. Use Search to filter notes by title or content.
  6. Pin important notes for quick access.

Storage

  • Notes directory: [User Home]/.BurpSuite/NotesPlusExtension/
  • Notes are stored as .md files.
  • Pin data is stored in .pins.properties in the same directory.
  • Filenames are sanitized from note titles for filesystem safety.

License

MIT. See LICENSE.

About

Notes+ is a Burp Suite extension designed to provide a seamless note-taking experience directly within Burp Suite. It allows security testers and developers to efficiently create, manage, and organize their findings, observations, and thoughts using Markdown, with a live HTML preview.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages