https://github.com/jamiefdhurst/obsidian-auto-periodic-notes
Obsidian plugin to create new periodic notes automatically in the background and allow these to be pinned in your open tabs. Requires the "Periodic Notes" plugin.
https://github.com/jamiefdhurst/obsidian-auto-periodic-notes
notes obsidian pkm plugin typescript
Last synced: about 1 month ago
JSON representation
Obsidian plugin to create new periodic notes automatically in the background and allow these to be pinned in your open tabs. Requires the "Periodic Notes" plugin.
- Host: GitHub
- URL: https://github.com/jamiefdhurst/obsidian-auto-periodic-notes
- Owner: jamiefdhurst
- License: mit
- Created: 2024-07-14T11:48:29.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T09:49:18.000Z (3 months ago)
- Last Synced: 2025-04-12T11:18:23.546Z (about 1 month ago)
- Topics: notes, obsidian, pkm, plugin, typescript
- Language: TypeScript
- Size: 1.85 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Automatic Periodic Notes for Obsidian
Creates new periodic notes automatically in the background and allows these to
be pinned in your open tabs; supports daily, weekly, monthly, quarterly and
yearly notes.
Designed to work with [Obsidian](https://obsidian.md), requires the [Periodic Notes](https://github.com/liamcain/obsidian-periodic-notes) plugin.
This plugin respects the settings of the Periodic Notes plugin, creating your notes using the templates, format and location you have selected.
## Features
- Creates new notes in the background for your periodic notes
- Supports daily, weekly, monthly, quarterly and yearly notes with individual settings for each
- Supports opening and pinning the new notes automatically when created
- Supports automatically closing older notes
- Can exclude weekends from daily note generation
## Settings
Automatic creation can be toggled on and off for each of the supported note types, these are only shown if you have enabled and configured these notes within the Periodic Notes plugin. Within each note type, you can set whether to open and pin the note automatically, or whether to simply create it in the background, showing a notice when complete.
## Development
This plugin has been developed using Typescript with the Obsidian and Periodic Notes APIs, Svelte for the UI and Jest for testing.
Once you've cloned the repository, to speed up plugin development it is recommended to symlink the location of the plugin directly into your local Obsidian:
```bash
ln -s obsidian-auto-periodic-notes ~/.obsidian/plugins/
```
You can then run the plugin build automatically to pick up any changes:
```bash
npm run dev
```
To test the plugin using just, you can run it with or without coverage:
```bash
npm run test
npm run coverage
```
When submitting a PR, the plugin will be automatically tested, and when merged into main this will be built and released using GitHub Actions.
## Thanks
Many thanks to [Liam Cain](https://liamca.in/hello) for the awesome work on the Periodic Notes plugin!