obsidian-plugin/munckenh_obsidian-relative-dates
1
0
Fork 0
mirror of https://github.com/munckenh/obsidian-relative-dates.git synced 2026-07-22 06:43:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
57 commits 1 branch 10 tags 332 KiB
TypeScript 84.8%
JavaScript 9.6%
CSS 5.6%
Find a file
Munckenh 9865320b98
chore: 1.0.3
2026-03-13 08:21:54 +08:00
.github ci: add release workflow 2026-03-11 11:52:11 +08:00
images docs: update screenshot-1.png 2026-02-21 10:01:57 +08:00
src fix: revert back to using createElement() 2026-03-13 08:14:40 +08:00
.gitignore chore: update comments 2026-03-13 08:17:09 +08:00
.npmrc chore: configure npm version 2025-10-11 01:32:07 +08:00
esbuild.config.mjs Initial commit 2025-08-11 18:23:36 +08:00
eslint.config.mjs chore: avoid false errors on non-sentence strings 2025-11-07 19:07:45 +08:00
LICENSE chore: update copyright year to 2026 2026-02-11 13:45:42 +08:00
manifest.json chore: 1.0.3 2026-03-13 08:21:54 +08:00
package-lock.json chore: 1.0.3 2026-03-13 08:21:54 +08:00
package.json chore: 1.0.3 2026-03-13 08:21:54 +08:00
README.md docs: update feature list 2026-02-19 10:07:45 +08:00
styles.css fix: make minor tweaks 2025-11-08 09:03:18 +08:00
tsconfig.json chore: update deps and linting config 2025-11-05 05:56:28 +08:00
version-bump.mjs feat: add live preview support 2025-08-13 00:24:51 +08:00
versions.json chore: 1.0.3 2026-03-13 08:21:54 +08:00

README.md

Relative Dates

A simple plugin for Obsidian that transforms date references in your task lists into color-coded elements that show relative dates.

Features

  • Converts date references in the format @ YYYY-MM-DD (with optional time HH:MM) into relative dates
  • Supports changing the default @ prefix through the plugin settings
  • Works in both Reading mode and Live Preview mode
  • Color-coded elements based on date proximity (overdue, today, tomorrow, this week, future)
  • Customizable colors through the plugin settings

Usage

Add dates in your task lists using the format:

  • @ 2025-08-12 for dates
  • @ 2025-08-12 14:30 for dates with time

The plugin will automatically convert these into easy-to-read elements such as:

Installation

  1. Clone the repository to .obsidian/plugins/: 
    git clone https://github.com/Munckenh/obsidian-relative-dates.git
  2. Install the dependencies and compile: 
    npm install
npm run build
  3. Enable the plugin in Obsidian

Release

To release a new version of the plugin:

  1. Update manifest.json with the new version number, such as 1.0.1, and the minimum Obsidian version required for the latest release.
  2. Run npm version patch, npm version minor, or npm version major.
  3. Create new GitHub release using the new version number as the "Tag version". Use the exact version number, don't include a prefix v. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
  4. Upload the files manifest.json, main.js, styles.css as binary attachments. Note: The manifest.json file must be in two places, first the root path of the repository and also in the release.
  5. Publish the release.

Scripts

To manage the plugin, you can use the following scripts:

  • Build the plugin by running npm run build or with live reload by running npm run dev
  • Improve code quality (optional) by running npm run lint