Skip to content

Releases: leechristophermurray/NoteDown

0.3.14

29 Aug 01:28
@leechristophermurray leechristophermurray
v0.3.14
30c84bb

Choose a tag to compare

View all tags
0.3.14 Latest
Latest

🚀 Key Features in v0.3.14

• Automated Executable Installation: noted setup now installs CLI globally
• Smart Installation Logic: Handles permissions and PATH detection intelligently
• Cross-Platform Support: Works on Linux, macOS, and Windows
• Enhanced Setup Command: New --skip-install flag for flexibility
• Comprehensive Documentation: Complete build system and contributing guides
• Streamlined User Experience: One-command installation process

🛠️ Technical Improvements

• Path detection logic for optimal installation directories
• Duplicate installation prevention
• Graceful permission handling (sudo when needed, user directories when possible)
• Dry-run support for testing installation process
• Better error messages and user guidance

📈 User Benefits

  1. Streamlined Setup: Single command to get fully working installation
  2. Better Accessibility: noted command available system-wide immediately
  3. Reduced Friction: No more manual binary copying or PATH configuration
  4. Cross-Platform Consistency: Proper installation on all supported OS
  5. Maintained Flexibility: Can still skip installation if preferred
Assets 13

0.1.0 (commit: 856cedf, built: 2025-08-29T00:42:11Z)

29 Aug 00:54
@leechristophermurray leechristophermurray
beta
67026e4

Choose a tag to compare

View all tags
0.1.0 (commit: 856cedf, built: 2025-08-29T00:42:11Z)

NoteDown 📝

A powerful Git-backed knowledge management system with CLI and VSCode integration.

Go
VSCode Extension
License

Overview

NoteDown is a comprehensive note-taking and knowledge management system that combines the power of Git version control with the convenience of modern editing tools. It features a robust command-line interface written in Go and a rich VSCode extension for GUI users.

🆕 Latest Features: Quick snippets, automatic setup, asset management, and enhanced WYSIWYG editing!

📚 Documentation

Features

🚀 Command-Line Interface

  • 📁 Repository Management: Initialize, sync, and manage note repositories
  • ✏️ Note Authoring: Create and edit notes with YAML frontmatter
  • 🏷️ Content Organization: Hierarchical listing and tagging system
  • ⚡ Quick Snippets: Instant note capture with noted "quick thought"
  • 🔧 Automatic Setup: One-command dependency installation
  • 📁 Asset Management: Organized media files with automatic indexing
  • 🔄 Version Control: Full Git integration with automatic commits
  • 📄 Export Capabilities: PDF export via Pandoc
  • 🔌 VSCode Integration: Built-in command to package the extension

🎨 VSCode Extension

  • ✨ WYSIWYG Editor: Live markdown editing with real-time preview
  • 🌲 Notes Explorer: Tree view with metadata display
  • 📊 Interactive Dashboard: Repository statistics and quick actions
  • 🎯 Slash Commands: Quick formatting with / shortcuts
  • ⌨️ Keyboard Navigation: Full keyboard support for menus and commands
  • 🔗 Seamless Integration: Direct CLI command execution from GUI

⚡ Quick Start

# 1. Initialize your first repository
mkdir my-notes && cd my-notes
noted init --remote=git@github.com:username/my-notes.git
# Will ask if you want to set this as your default repository

# 2. Create your first note
noted new "My First Note"

# 3. Add a quick snippet from anywhere
noted snippet "This is a quick thought I want to capture"

# 4. List and organize your notes
noted list --format=tree

# 5. Save and sync everything
noted save -m "My first notes"
noted sync

🎯 For a complete walkthrough, see Quick Start Guide

📋 Command Reference

🆕 Quick Actions

  • noted "text" - Add quick snippet to default repository
  • noted setup - Install all dependencies automatically
  • noted set default <path> - Set default repository for snippets

📁 Repository Management

  • noted init [directory] - Initialize a new noted repository
  • noted rescan - Rebuild note and asset indexes
  • noted sync - Synchronize with remote Git repository

✏️ Note Operations

  • noted new "Title" - Create a new note
  • noted edit "search-term" - Edit an existing note
  • noted list [--format=tree|json] - List notes with metadata
  • noted snippet "text" - Add timestamped snippet

💾 Content Management

  • noted save [-m "message"] - Save and commit all changes
  • noted export note.md --pdf - Export note to PDF

🔧 Development

  • noted vsix - Build and package the VSCode extension

📖 For complete command documentation, see CLI Usage Guide

🎨 VSCode Extension

⚡ Quick Install

# Build and install the extension
noted vsix
# Then install the generated .vsix file in VSCode

✨ Key Features

  • 🔥 WYSIWYG Editor: Live markdown editing with instant preview
  • ⚡ Slash Commands: Type / for quick formatting options
  • 🌲 Smart Explorer: Browse notes with rich metadata
  • 📊 Live Dashboard: Real-time statistics and insights
  • ⌨️ Keyboard Navigation: Full keyboard support
  • 📱 Asset Management: Drag-and-drop media files

📖 For detailed extension documentation, see VSCode Extension Guide

Configuration

Global Config (~/.config/noted/config.yaml)

default_editor: "code"
git:
  user_name: "Your Name"
  user_email: "your.email@example.com"
templates:
  basic:
    tags: []
    category: "notes"

Local Config (.noted)

version: "1.0"
git:
  remote_url: "git@github.com:user/notes.git"
  auto_sync: true
index:
  scan_patterns: ["*.md", "*.txt"]
export:
  pandoc:
    output_dir: "exports"

Note Format

Notes use Markdown with YAML frontmatter:

---
title: "Note Title"
tags: ["development", "golang"]
category: "programming"
created_at: 2025-08-28T14:30:00-06:00
updated_at: 2025-08-28T15:45:00-06:00
---

# Note Content

Your markdown content goes here with full GitHub Flavored Markdown support.

Full Changelog: https://github.com/leechristophermurray/NoteDown/commits/beta

Loading