README file from
GithubWriting Tracker Heatmap Streaks
Writing Tracker Heatmap Streaks is an Obsidian plugin that tracks the new words you write each day, sends a webhook when you hit your goal, and shows your writing history in a compact heatmap sidebar with a detailed stats view.
Features
- Track daily new words instead of total file length.
- Send a webhook when the configured daily word goal is reached.
- View a sidebar heatmap with today's count and current streaks.
- Open a detailed stats modal with yearly history and monthly totals.
- Import past history from the
obsidian-daily-statsplugin.
Installation
From community plugins
Install Writing Tracker Heatmap Streaks from Obsidian's community plugins browser once the plugin has been approved and published.
Manual installation
- Download
main.js,manifest.json, andstyles.cssfrom the latest GitHub release. - Create this folder in your vault:
<vault>/.obsidian/plugins/word-goal-webhook/
- Copy the three release files into that folder.
- Reload Obsidian.
- Enable Writing Tracker Heatmap Streaks under Settings -> Community plugins.
Usage
The plugin tracks your current daily word count in the status bar. The sidebar heatmap can be opened when needed, and each day is shaded based on how many words you wrote relative to your strongest writing day for that year.
Commands:
Open writing heatmapOpen writing statsShow today's word countImport history from Daily Stats plugin
Settings:
- Webhook URL: endpoint to call when the daily goal is met.
- Daily word goal: number of new words required before the webhook fires.
- Heatmap colour: choose one of the built-in color presets.
- Goal-met visual cue: show or hide the marker on days where the goal was reached.
When the goal is reached, the plugin sends a POST request with a JSON payload like:
{
"event": "daily_word_goal_reached",
"goal": 500,
"actual": 512,
"date": "2026-03-27",
"timestamp": "2026-03-27T14:23:01.000Z"
}
Data and privacy
- Plugin data is stored in your vault under
.obsidian/plugins/word-goal-webhook/data.json. - The plugin also keeps rolling backup copies in the same folder as
data.backup-1.jsonthroughdata.backup-3.jsonand automatically restores the newest valid copy ifdata.jsonis missing or corrupted. - The plugin makes network requests only when you configure a webhook URL and your daily goal is reached.
- The plugin does not require an account, payment, ads, or telemetry.
- The source code in this repository is open source.
Development
npm install
npm run build
npm run deploy:runtime
npm run deploy:runtime copies only main.js, manifest.json, and styles.css into the local Obsidian plugin folder and removes development-only files from that installed copy. Set OBSIDIAN_PLUGIN_DIR to deploy to a different vault.
Create releases by attaching main.js, manifest.json, and styles.css to a GitHub release whose tag matches the manifest version.