inkdrop-note-templates's Introduction

inkdrop-note-templates

Note template system for Inkdrop.

https://twitter.com/azu_oss/status/1266670458532847616

Installation

Install with ipm:

ipm install inkdrop-note-templates

inkdrop-note-templates - Plugin - Inkdrop

Usage

Create Templates

You can create templates in two ways.

Create templates under _Templates notebook.
Create templates by assigning Template tag to them.

📝 Currently _Templates and Template are hard-coded names, welcome to Pull Request!

Note template should have content and metadata as Yaml Front Matter.

id: unique id for command
label: Menu label for the template
title: Render title with LiquidJS and set it as new note's title
note's body: Render body with LiquidJS and set it as new note's body

📝 Inherit other properties like tags from Template note.

---
id: test
label: "Test Template"
title: "Test Title"
---

Test body text.

- item 1
- item 2

inkdrop-note-templates use LiquidJS. so, You can use template syntax in title and body.

---
id: today-task
label: "Today Task"
title: "{{'now' | date: '%Y-%m-%d'}} Task"
---

## TODO

- [ ] TASK

Use Templates

You can create new note from "File" > "Templates" > your templates.

⚠️ If you have updated your template, Please restart inkdrop application.

Shortcut for Template

Call inkdrop-note-templates:${template.id} from shortcut and create a new note with the template.

You open your keymap.cson and edit it.

Following example create new file with id: today-task template.

'body':
  'cmd-shift-e': 'inkdrop-note-templates:today-task'

Related Inkdrop plugins

Search Topics: inkdrop on GitHub.

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

License

MIT

References

Creating a Note Template | Inkdrop Documentation

inkdrop-note-templates's People

Contributors

Stargazers

Watchers

inkdrop-note-templates's Issues

feature request: snippet style entry

Hi,

Love the plugin, not sure if this is possible but it would be great to be able to add variables that could be tabbed through, sismilar to a code snippet in VS Code.

---
title: ${1:}
categories: ${2}
tags: ${3}
---

Intro: 
${4}

Outro:
${5}

when a template is used, tabbing would take you through each of the numbered variables to enter the text, this would speed up entry and defaults could also be set with ${1:MyTitle}

TypeError · Cannot read property 'forEach' of undefined

It occurs at: inkdrop-note-templates.js:84:19 Object.activate

I don't use this plugin but am receiving it via Bugsnag, so it's just FYI.
I guess it happens when no templates available.
Hope that helps improve it!

Set and access LiquidJS variables from within the headers or swallow LiquidJS newlines

What I have:

---
id: tomorrow
label: "Tomorrow"
title: "{% assign day = 'now' | date: '%a' %}{% if day == 'Fri' %}{{'now' | date: '%s' | plus: 259200 | date: '%d-%m-%Y'}}{% else %}{{'now' | date: '%s' | plus: 86400 | date: '%d-%m-%Y'}}{% endif %}"
---

{% assign yesterday = 'now' | date: '%d-%m-%Y' %}
{% if day == 'Fri' %}
{% assign tomorrow = 'now' | date: '%s' | plus: 345600 | date: '%d-%m-%Y' %}
{% else %}
{% assign tomorrow = 'now' | date: '%s' | plus: 172800 | date: '%d-%m-%Y' %}
{% endif %}

Yesterday: [[{{ yesterday }}]]
Tomorrow: [[{{ tomorrow }}]]

## Tasks

- [ ]

## Pomo

- [ ] [-p15]
- [ ] [-p5]
- [ ] [-p15]
- [ ] [-p5]
- [ ] [-p15]
- [ ] [-p5]
- [ ] [-p15]
- [ ] [-p5]
- [ ] [-p30]

## Notes

-

{% assign day = 'now' | date: '%a' %}
{% if day == 'Thu' || day == 'Tue' %}

## Silent Stand-Up

_Yesterday_

-

_Today_

-

{% endif %}

What I get when I generate a new note from the above template:

Solution:

Either ensure that all text parsed with LiquidJS is completely removed including new lines, or set up something in the header so that I can set variables from there and access them.

I'd be willing to help here, but I don't have much experience with JS at all.

Recommend Projects

azu / inkdrop-note-templates Goto Github PK