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
125 commits 1 branch 10 tags 332 KiB
TypeScript 84.8%
JavaScript 9.6%
CSS 5.6%
Find a file
Munckenh 2a262b1111
refactor: improve type safety
2026-05-14 09:59:09 +08:00
.github ci: update GitHub action versions 2026-03-25 10:26:15 +08:00
images docs: update screenshot-1.png 2026-02-21 10:01:57 +08:00
src refactor: improve type safety 2026-05-14 09:59:09 +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 style: fix linting issues 2026-03-27 09:17:09 +08:00
eslint.config.mjs chore: update dependencies and configuration 2026-05-13 14:02:29 +08:00
LICENSE chore: update copyright year to 2026 2026-02-11 13:45:42 +08:00
manifest.json chore: 1.4.0 2026-05-13 14:03:51 +08:00
package-lock.json chore: 1.4.0 2026-05-13 14:03:51 +08:00
package.json chore: 1.4.0 2026-05-13 14:03:51 +08:00
README.md docs: remove pull request link 2026-05-13 13:56:33 +08:00
styles.css refactor: remove !important 2026-05-13 08:08:49 +08:00
tsconfig.json fix: use window.moment() 2026-04-05 00:24:59 +08:00
version-bump.mjs chore: update version bump logic 2026-05-13 13:57:06 +08:00
versions.json fix: lower minAppVersion to 1.2.7 2026-04-16 10:34:53 +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. Go to the latest release.
  2. Download main.js, manifest.json, and styles.css from the release assets.
  3. Create this folder in your vault: .obsidian/plugins/obsidian-relative-dates
  4. Move the downloaded files into that folder.
  5. Enable the plugin in Obsidian.

Install from source

  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 the minAppVersion in manifest.json if the new release requires a higher minimum Obsidian version.
  2. Run npm version patch, npm version minor, or npm version major. This automatically updates the version correctly, creates a version commit, and adds the corresponding git tag.
  3. Push the commit and the new tag to GitHub: 
    git push --follow-tags
  4. A GitHub Action will automatically run, build the plugin, and create a release draft containing the required binary attachments (manifest.json, main.js, styles.css).
  5. Go to the GitHub repository's Releases page, review the drafted release notes, and 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.