Code Monkey home page Code Monkey logo

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.

  1. Create templates under _Templates notebook.
  2. 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.

template menu

โš ๏ธ 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

  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

inkdrop-note-templates's People

Contributors

azu avatar chbrianliu avatar 515hikaru avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.