Skip to content

Repository files navigation

Writing Tracker for Obsidian

Writing Tracker is an Obsidian plugin for tracking writing progress by project. It is designed for writers who want to manage active projects, monitor word count progress, and log writing sessions without leaving their vault.

What This Plugin Is For

This plugin helps you:

  • create and manage multiple writing projects
  • set a starting word count for in-progress work
  • track progress manually or by counting words from a file or folder in your vault
  • set optional word-count and time goals for each project
  • start and stop writing sessions and save session history

The plugin is intended to give you a lightweight way to see project progress and capture writing activity directly inside Obsidian.

Current Features

  • Sidebar view for writing projects
  • Per-project tracking modes:
    • manual
    • single file
    • folder
  • Word-count adjustments for writing done outside tracked notes
  • Writing session start/stop workflow
  • Session history stored in plugin data

Pulling Down The Project

Clone the repository into your local Obsidian plugins directory or into another development folder:

git clone <your-repo-url> obsidian-writing-tracker
cd obsidian-writing-tracker

If you want to develop it directly inside a test vault, place it at:

<YourVault>/.obsidian/plugins/obsidian-writing-tracker

Local Development

Install dependencies:

npm install

Start the development build:

npm run dev

Create a production build:

npm run build

Run linting:

npm run lint

Installing In Obsidian

To install the plugin manually in a vault:

  1. Copy manifest.json, main.js, and styles.css into:
<YourVault>/.obsidian/plugins/obsidian-writing-tracker
  1. Open Obsidian.
  2. Go to Settings -> Community plugins.
  3. Enable Writing Tracker.

Notes

  • The plugin id is writing-tracker.
  • The current minimum Obsidian version in manifest.json is 0.15.0.

About

A writing tracker plugin for obsidian

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages