MiniNotes

A lightweight, web-based Markdown note-taking tool that stores notes in a local note.md file.

Features

• GitHub-style Markdown rendering
• Web-based editor with save/cancel functionality
• Local file storage (notes saved to ~/.mininotes/note.md)
• Customizable server port via command line flags

Installation

Prerequisites

• Go 1.18+ (for building from source)

Build from Source

# Clone the repository
git clone https://github.com/cjacker/mininotes.git
cd mininotes

# Build the binary
go build -o mininotes main.go

Alternatively, install directly via go install:

go install github.com/cjacker/mininotes@latest

Usage

Start the Server

# Run with default port (8080)
./mininotes

# Run with a custom port (e.g., 3000)
./mininotes --port 3000
# Or use the short flag
./mininotes -p 3000

Use the Tool

1. Visit http://localhost:<port> (e.g., http://localhost:8080) in your browser
2. Click "Edit Notes" to enter edit mode
3. Make changes to your notes (supports standard Markdown syntax)
4. Click "Save Notes" to save changes (written to ~/.mininotes/note.md)
5. Click "Cancel" to discard changes and return to the view page
6. Usually I use current date as Heading 1, Click "Insert date" will insert current date at the top of text.

File Location

Your notes are stored in the auto-created file:

~/.mininotes/note.md

Initial content (including usage instructions) is added if the file doesn't exist.