Skip to content

junevm/boxflow-obsidian

Repository files navigation

The most satisfying visual progress tracker for Obsidian. Map your workflows into modular, colorful box grids.

Why Boxflow?

Obsidian Downloads License: MIT

Traditional task managers can feel like a chore. Boxflow turns your Obsidian notes into interactive, gamified boards. It's the perfect bridge between a simple checklist and a complex database.

  • Visual Clarity: See exactly how far you've come with high-contrast Material 3 colors.
  • Zero Friction: One click = one unit of progress.
  • Seamless Integration: Works natively with your markdown files.
Boxflow Demo Boxflow Demo 1 Boxflow Demo 3

⚡ Key Features

  • Modular Grids: Organize tasks into categorized cards.
  • Micro-Interactions: Animated checkmarks and smooth, reactive state changes.
  • Pro Interface: iOS and Material 3 inspired aesthetics for a premium Obsidian experience.
  • JSON Powered: Ultra-reliable data storage inside hidden code blocks—no more broken markdown parsing.
  • Bulk Operations: Instantly scale your grids with the "Bulk Add" feature.

🎯 Use Cases

1. Learning & Skills Tracking

Track your journey through coding bootcamps, language certifications, or reading challenges.

  • Example: Fullstack Web Dev - 100 projects.

2. Habits & Consistency

A beautiful, visual layout for daily streaks, gym sessions, or meditation logs.

  • Example: 30-Day Yoga Challenge.

3. Collections & Inventory

Perfect for tracking your backlog, vinyl records, or travel bucket lists.

  • Example: 100 Movies to Watch.

4. High-Volume Projects

Break down massive goals (like writing a book or finishing a thesis) into manageable, satisfying boxes.

Usage

Getting Started

  1. Open any note in Obsidian.
  2. Run the command "Boxflow: Toggle Boxflow / Markdown view" from the Command Palette (Ctrl/Cmd + P) or right-click a file and select "Open as Boxflow board".
  3. Click + Category to create your first grid.

Managing Grids

  • Add Boxes: Click the + icon inside a category to add a single box.
  • Bulk Add: Click the three dots (⋮) on a category and select Add Boxes in Bulk to add multiple boxes at once (great for large tracking projects).
  • Pro Colors: Use the category menu (⋮) to assign Material 3 colors to your grids.
  • Organization: Drag and drop the category cards to reorder them.

Editing Note Content

  • Rename Categories: Click the category name to edit it inline.
  • Rename Note: Click the note title in the header to rename the file.
  • Context Menu: Right-click the view tab to access "Edit as Markdown" or "Delete Note".

Installation

Community Plugins

  1. Search for Boxflow in the Obsidian Community Plugins.
  2. Click Install, then Enable.

Manual Installation

  1. Download the latest release (main.js, manifest.json, styles.css).
  2. Move them into your vault's plugin folder: .obsidian/plugins/boxflow/.
  3. Restart Obsidian.

Contributing

We welcome contributions! Please see our CONTRIBUTING.md for details.

License

See LICENSE for details.

About

The most satisfying visual progress tracker for Obsidian

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors