Obsidian Templater plugin

Date Module

This module contains every internal function related to dates.

• Documentation

  • tp.date.now(format: string = "YYYY-MM-DD", offset?: number⎮string, reference?: string, reference_format?: string)

  • tp.date.tomorrow(format: string = "YYYY-MM-DD")

  • tp.date.weekday(format: string = "YYYY-MM-DD", weekday: number, reference?: string, reference_format?: string)

  • tp.date.yesterday(format: string = "YYYY-MM-DD")

• Moment.js

• Examples

Documentation

Function documentation is using a specific syntax. More information here.

tp.date.now(format: string = "YYYY-MM-DD", offset?: number⎮string, reference?: string, reference_format?: string)

Retrieves the date.

Arguments

• format: The format for the date. Defaults to "YYYY-MM-DD". Refer to format reference.

• offset: Duration to offset the date from. If a number is provided, duration will be added to the date in days. You can also specify the offset as a string using the ISO 8601 format.

• reference: The date referential, e.g. set this to the note's title.

• reference_format: The format for the reference date. Refer to format reference.

Examples

// Date now
<% tp.date.now() %>

// Date now with format
<% tp.date.now("Do MMMM YYYY") %>

// Last week
<% tp.date.now("YYYY-MM-DD", -7) %>

// Next week
<% tp.date.now("YYYY-MM-DD", 7) %>

// Last month
<% tp.date.now("YYYY-MM-DD", "P-1M") %>

// Next year
<% tp.date.now("YYYY-MM-DD", "P1Y") %>

// File's title date + 1 day (tomorrow)
<% tp.date.now("YYYY-MM-DD", 1, tp.file.title, "YYYY-MM-DD") %>

// File's title date - 1 day (yesterday)
<% tp.date.now("YYYY-MM-DD", -1, tp.file.title, "YYYY-MM-DD") %>

tp.date.tomorrow(format: string = "YYYY-MM-DD")

Retrieves tomorrow's date.

Arguments

• format: The format for the date. Defaults to "YYYY-MM-DD". Refer to format reference.

Examples

// Date tomorrow
<% tp.date.tomorrow() %>

// Date tomorrow with format
<% tp.date.tomorrow("Do MMMM YYYY") %>

tp.date.weekday(format: string = "YYYY-MM-DD", weekday: number, reference?: string, reference_format?: string)

Arguments

• format: The format for the date. Defaults to "YYYY-MM-DD". Refer to format reference.

• weekday: Week day number. If the locale assigns Monday as the first day of the week, 0 will be Monday, -7 will be last week's day.

• reference: The date referential, e.g. set this to the note's title.

• reference_format: The format for the reference date. Refer to format reference.

Examples

// This week's Monday
<% tp.date.weekday("YYYY-MM-DD", 0) %>

// Next Monday
<% tp.date.weekday("YYYY-MM-DD", 7) %>

// File's title Monday
<% tp.date.weekday("YYYY-MM-DD", 0, tp.file.title, "YYYY-MM-DD") %>

// File's title previous Monday
<% tp.date.weekday("YYYY-MM-DD", -7, tp.file.title, "YYYY-MM-DD") %>

tp.date.yesterday(format: string = "YYYY-MM-DD")

Retrieves yesterday's date.

Arguments

• format: The format for the date. Defaults to "YYYY-MM-DD". Refer to format reference.

Examples

// Date yesterday
<% tp.date.yesterday() %>

// Date yesterday with format
<% tp.date.yesterday("Do MMMM YYYY") %>

Moment.js

Templater gives you access to the moment object, with all of its functionalities.

More information on moment.js here.

Examples

// Date now
<% moment(tp.file.title, "YYYY-MM-DD").format("YYYY-MM-DD") %>

// Get start of month from note title
<% moment(tp.file.title, "YYYY-MM-DD").startOf("month").format("YYYY-MM-DD") %>

// Get end of month from note title
<% moment(tp.file.title, "YYYY-MM-DD").endOf("month").format("YYYY-MM-DD") %>

Examples

// Date now
<% tp.date.now() %>

// Date now with format
<% tp.date.now("Do MMMM YYYY") %>

// Last week
<% tp.date.now("YYYY-MM-DD", -7) %>

// Next week
<% tp.date.now("YYYY-MM-DD", 7) %>

// Last month
<% tp.date.now("YYYY-MM-DD", "P-1M") %>

// Next year
<% tp.date.now("YYYY-MM-DD", "P1Y") %>

// File's title date + 1 day (tomorrow)
<% tp.date.now("YYYY-MM-DD", 1, tp.file.title, "YYYY-MM-DD") %>

// File's title date - 1 day (yesterday)
<% tp.date.now("YYYY-MM-DD", -1, tp.file.title, "YYYY-MM-DD") %>

// Date tomorrow
<% tp.date.tomorrow() %>

// Date tomorrow with format
<% tp.date.tomorrow("Do MMMM YYYY") %>

// This week's Monday
<% tp.date.weekday("YYYY-MM-DD", 0) %>

// Next Monday
<% tp.date.weekday("YYYY-MM-DD", 7) %>

// File's title Monday
<% tp.date.weekday("YYYY-MM-DD", 0, tp.file.title, "YYYY-MM-