https://github.com/pjkaufman/obsidian-simple-planner

This is an Obsidian plugin that works as a simple planner for personal use.
https://github.com/pjkaufman/obsidian-simple-planner

Last synced: about 1 month ago
JSON representation

This is an Obsidian plugin that works as a simple planner for personal use.

• Host: GitHub
• URL: https://github.com/pjkaufman/obsidian-simple-planner
• Owner: pjkaufman
• Created: 2023-11-28T00:58:27.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2023-12-13T20:07:51.000Z (11 months ago)
• Last Synced: 2023-12-13T23:22:58.973Z (11 months ago)
• Language: TypeScript
• Size: 104 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Simple Planner

A plugin designed to be a simple and work on checklist items in a file with recurring events.

## How it Works

There are a list of calendars and events that exist. Each event must be attached to at least 1 calendar.

The plugin exposes several methods that can be used via Templater or elsewhere to get events for a specific day or date range.

``` TypeScript

// gets the formatted section for the specified calendars for the day provided

getEventsForDay(date: string | undefined, calendarsToInclude: string[] = [], calendarsToIgnore: string[] = []): string

// gets the weekly, monthly, and yearly events for the calendars specified for the date range specified.

getWeeklyMonthlyYearlyEventsForRange(startDate: string | undefined, endDate: string | undefined, calendarsToInclude: string[] = [], calendarsToIgnore: string[] = []): string[] | string[][]

```

These functions help determine which events are on which days which can then be responded to accordingly.

## How to use

- Clone this repo.

- Make sure your NodeJS is at least v16 (`node --version`).

- `npm i` or `yarn` to install dependencies.

- `npm run dev` to start compilation in watch mode.

## Manually installing the plugin

- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.