inkdrop-note-templates

KO | EN

gitlite — search

#hacktoberfest #ai #llm #go #android #machine-learning #linux #docker #macos #nodejs #windows #awesome #awesome-list #ios

inkdrop-note-templates

(★ 10)

Note template system for Inkdrop

inkdrop-note-templates Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# inkdrop-note-templates

Note template system for [Inkdrop](https://inkdrop.app).

[![](https://raw.githubusercontent.com/azu/inkdrop-note-templates/master/docs/resources/video.png)](https://twitter.com/azu_oss/status/1266670458532847616)
> https://twitter.com/azu_oss/status/1266670458532847616

## Installation

Install with [`ipm`](https://docs.inkdrop.app/manual/extend-inkdrop-with-plugins):

ipm install inkdrop-note-templates

> [inkdrop-note-templates - Plugin - Inkdrop](https://my.inkdrop.app/plugins/inkdrop-note-templates)

## Usage

### Create Templates

You can create templates in two ways.

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

:memo: Currently `_Templates` and `Template` are hard-coded names, welcome to Pull Request!

Note template should have content and metadata as [Yaml Front Matter](https://jekyllrb.com/docs/front-matter/).

- `id`: unique id for [command](https://docs.inkdrop.app/manual/list-of-commands)
- `label`: Menu label for the template
- `title`: Render title with [LiquidJS](https://liquidjs.com/) and set it as new note's title 
- note's body: Render body with [LiquidJS](https://liquidjs.com/) and set it as new note's body
 
:memo: Inherit other properties like tags from Template note.
 
```markdown
---
id: test
label: "Test Template"
title: "Test Title"
---

Test body text.

- item 1
- item 2
```

inkdrop-note-templates use [LiquidJS](https://liquidjs.com/).
so, You can use template syntax in `title` and body.

```markdown
---
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.

![template menu](https://raw.githubusercontent.com/azu/inkdrop-note-templates/master/docs/resources/template.png)

:warning: 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](https://docs.inkdrop.app/manual/customizing-keybindings) and edit it.

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

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

## Related Inkdrop plugins

Search [Topics: inkdrop](https://github.com/topics/inkdrop?q=user%3Aazu) on GitHub.

## Contributing

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

## License

MIT

## References

- [Creating a Note Template | Inkdrop Documentation](https://docs.inkdrop.app/manual/creating-a-note-template)

inkdrop-note-templates

inkdrop-note-templates Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

inkdrop-note-templates

inkdrop-note-templates Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README