Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mulfok/periodic-note-templates
A set of periodic note templates for Obsidian.md.
https://github.com/mulfok/periodic-note-templates
obsidian-md personal-knowledge-management templates
Last synced: 3 months ago
JSON representation
A set of periodic note templates for Obsidian.md.
- Host: GitHub
- URL: https://github.com/mulfok/periodic-note-templates
- Owner: mulfok
- Created: 2022-03-04T01:25:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T04:03:46.000Z (almost 2 years ago)
- Last Synced: 2024-07-29T16:34:41.612Z (4 months ago)
- Topics: obsidian-md, personal-knowledge-management, templates
- Language: JavaScript
- Homepage:
- Size: 48.8 KB
- Stars: 288
- Watchers: 10
- Forks: 43
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - mulfok/periodic-note-templates - A set of periodic note templates for Obsidian.md. (JavaScript)
README
# MK's Periodic Note Templates
A set of periodic note templates for Obsidian.md.
*Theme: [Viridian](https://github.com/mulfok/obsidian-viridian)*
___
## Before You Start...
This collection of templates suit my **current** workflow. I supply them here and try to keep them to-date so that you lovely people are also able to use them. _By all means,_ you are encouraged to change the templates when you download them (you'll have to regardless, it's part of setup 😛) you may use a date format that I don't (these templates use YYYY-MM-DD by the way) or you may want to change what these notes track and whatnot. In short, these could/should be considered as a **base** to **your** perfect periodic note template.
These templates also assume you know how to use the plugins required. If you don't, please refer to the instructions on their repos--I unfortunately don't have the time to write a full-blown tutorial on how to install each and every single plugin.
> By the way, if you're having a problem and would like some help from me, please DM me on _Discord._ Just requesting this so you can get help quicker, since I only open Github like, once a day. 😆
## Required Plugins
- [CustomJS](https://github.com/samlewis0602/obsidian-custom-js)
- [Dynamic Table of Contents](https://github.com/Aidurber/obsidian-plugin-dynamic-toc)
- [Dataview](https://github.com/blacksmithgu/obsidian-dataview) (_ensure JS queries are enabled_)
- [Obsidian Banners](https://github.com/noatpad/obsidian-banners)
- [Obsidian Charts](https://github.com/phibr0/obsidian-charts)
- [Periodic Notes](https://github.com/liamcain/obsidian-periodic-notes)
- [Tasks](https://github.com/schemar/obsidian-tasks)
- [Templater](https://github.com/SilentVoid13/Templater)
## Setup
These notes require a little TLC to get them off of the ground. Other than installing the plugins listed above, we additionally need to configure...
1. The code required for the graph
1. The actual graph codeblock
1. The banners used throughout the notes
### CustomJS Graph Code
The graph in the Weekly Note uses a CustomJS file built by [Olivier Carizzoni](https://github.com/oliviercarizzoni). In addition to functioning as a normal [Obsidian Charts](https://github.com/phibr0/obsidian-charts) chart, it adds the functionality to have each value you track trimmed down by an average that you provide.
For example, I track **steps** with an average of **10 000 steps.** Being able to show an average is extremely useful in being able to see all the values you track clearly. If this wasn't done, then I'd likely be only able to see the steps I've taken clearly, and much smaller values (like Hours Worked) would be completely buried.
Let's go about setting up this custom file.
1. First, make sure that [CustomJS](https://github.com/samlewis0602/obsidian-custom-js) is installed in Obsidian.
2. Once that's done, go to [Scripts/CustomJS](https://github.com/mulfok/periodic-note-templates/tree/main/Scripts/CustomJS) in this repo and download the `DvCharts.js` file.
3. Once you have, move it into an appropriate location in your vault. I've put mine in `AA Utilities/AA.04 Scripts`.
4. Next, go to the CustomJS plugin settings and set **Folder** to the path where you put the JS file.
5. Reload Obsidian, and you'll be good to go!
### Graph Codeblock
In the Weekly Note Templates's graph codeblock, you'll need to configure the `daysPath` found at the bottom of the file. For example, mine is set to `'02 Personal/02.01 Periodic Notes/<% tp.date.now("YYYY") %>/Daily/<% tp.date.now("MM MMMM") %>'`, which on compile gets turned into something like `02 Personal/02.01 Periodic Notes/2022/Daily/05 March`.
In short, change this field to match the **path where you have your Daily Notes.**
### Banner Images
You may notice that in the examples in this repo, there are banners that compliment the notes. By default, they are set as `![[<% tp.date.now("YYYY MMMM") %> Weekly Banner.jpg]]` in the template's frontmatter. When generating a new daily note, it will be translated to `![[2022 March Weekly Banner.jpg]]`. I personally like to have different banners for each month of the year, so I have a small backlog of chronologically named banners.
If you have a different file format for your images, no need to fret! Just change the `.jpg` to your desired format: `.png`, `.svg`, etc...
___
## Template Overview
Let's briefly look at each periodic note type, and what their intended functions are.
### Daily Notes
I use **Daily Notes** to fill out short dataview fields when as I feel like it, and to take memos and work logs of my day.
I track habits, the weather, tasks, and various statistics about my day. The fields found within these notes are then pulled into the **Weekly Note** that it is linked to, which is used for the automatic review.
#### Learnt Words
You may notice that there's a field for **learnt words.** It's a useful thing to keep track of (especially in language learning) but there is a special format required in order for the field to work.
```
- Learnt Words:: "word one", "meaning", "word two", "meaning"
```
You can have any number of words in the field, but it must **always** be formatted as `"word", "meaning"`. If it is formatted incorrectly, the table on the weekly note will separate each character as it's own field, which doesn't look right.
Additionally, make sure that the quotation marks surrounding your fields are **not curled.** That means use these: `""` and not these: `“”`.
### Weekly Notes
I use **Weekly Notes** to reflect on my week as a whole. It automatically pulls in all the Memos, Work Logs, and Dataview fields from its corresponding Daily Notes.
This note functions quite well on its own, and requires little interaction to change things.
___
## Attribution
Huge thanks to the following people for...
- ❤️ [Olivier Carizzoni](https://github.com/oliviercarizzoni): Improved graph code and dedicated custom JS
- 🧡 Braden1996#5496 (Discord): Learnt words table concept
## Support me!
Check out my other stuff:
- [Absolve](https://github.com/mulfok/obsidian-absolve)
- [mulfok's garden](https://publish.obsidian.md/mulfok-vault)
- [Viridian](https://github.com/mulfok/obsidian-viridian)
## Contact
- Discord: @mulfok#6931
- Twitter: @mulfok