Skip to content

A powerful, minimalist note-taking extension for VS Code. Create, organize, and manage your markdown notes with ease. Features live preview, custom templates, and a clean interface.

License

Notifications You must be signed in to change notification settings

harshit2608/zen-notes

Repository files navigation

ZenNotes for VS Code

📝 ZenNotes

Your Zen Space for Note-Taking in VS Code

✨ Features

  • 📝 Smart Note Creation

    • Instantly create notes with beautiful templates
    • Support for multiple note types (Meeting, Task, General)
    • Auto-date insertion and custom variables
  • 🎯 Organized Workspace

    • Dedicated Notes Explorer in the activity bar
    • Hierarchical note organization
    • Quick access to recent notes
  • 👁 Real-time Preview

    • Side-by-side Markdown preview
    • Auto-refresh as you type
    • Beautiful styling with custom CSS
  • 🎨 Customization

    • Multiple pre-built templates
    • Customizable note directory
    • Configurable preview settings

🚀 Getting Started

  1. Install the extension
  2. Click the ZenNotes icon in the Activity Bar (📝)
  3. Select your notes directory using the folder icon
  4. Start creating notes with Cmd/Ctrl + Shift + P → "ZenNotes: Create New Note"

⌨️ Commands

Command Description Shortcut
ZenNotes: Select Notes Directory Choose where to store your notes -
ZenNotes: Create New Note Create a new note from template -
ZenNotes: Open Notes Open the notes explorer -
ZenNotes: Toggle Live Preview Toggle real-time preview -

💡 Pro Tip: Assign keyboard shortcuts to these commands for faster access!

⚙️ Configuration

Customize ZenNotes through VS Code settings:

{
  // Directory for storing notes
  "zenNotes.notesDirectory": "/path/to/notes",

  // Enable/disable live preview
  "zenNotes.livePreview": true,

  // Custom note templates
  "zenNotes.templates": {
    "meeting": {
      "content": "# Meeting: {{title}}\n\nDate: {{date}}\n\n## Attendees\n\n## Notes",
    },
    "task": {
      "content": "# Task: {{title}}\n\nCreated: {{date}}\n\n## Description\n\n## Checklist",
    },
  },
}

🎨 Template Variables

Available variables for templates:

  • {{title}}: Note title
  • {{date}}: Current date
  • {{time}}: Current time
  • {{datetime}}: Current date and time

🔒 Security & Privacy

  • All notes are stored locally on your machine
  • No data is sent to external servers
  • Full control over your note directory location

📝 Note Types

  1. Meeting Notes

    • Pre-formatted structure for meetings
    • Sections for attendees, agenda, and action items
    • Date auto-insertion
  2. Task Notes

    • Checklist format
    • Progress tracking
    • Priority markers
  3. General Notes

    • Clean, minimal template
    • Flexible structure
    • Perfect for quick thoughts

🛠 Tips & Tricks

  1. Quick Access

    • Pin frequently used notes
    • Use the command palette for fast navigation
    • Organize notes in subdirectories
  2. Productivity

    • Use keyboard shortcuts
    • Enable auto-save
    • Utilize the live preview
  3. Organization

    • Create a consistent naming convention
    • Use date prefixes for temporal notes
    • Leverage subdirectories for categories

📄 License

Copyright © 2024 bharsh2608. All Rights Reserved. This extension is proprietary software. See LICENSE file for details.

👨‍💻 Author

Created with 💖 by bharsh2608

About

A powerful, minimalist note-taking extension for VS Code. Create, organize, and manage your markdown notes with ease. Features live preview, custom templates, and a clean interface.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published