Other Settings

File Level Settings and Properties

Use YAML front matter in any markdown file to add capabilities to the cards it contains.

---
tags: # Tags that will be on every card in this file
  - story
  - enhancement
context: # Context that will be on every card in this file
  - github
meta:
  sprint:
   - 1
template: |
  :100: Days of code, Day ${daysIn}: ${today}
  :rocket:
  :thought_balloon:
  :link: imdone.io
  #100daysofcode #programmer #developer #markdown #Productivity #indiehackers #blogger
  <!-- created: ${timestamp} -->
---

template

---
# more yaml...
template: | # This is the template for new cards
  :100: Days of code, Day ${daysIn}: ${today}
  :rocket: **Progress:**  your progress here
  :thought_balloon: **Thoughts:**  your thoughts here
  :link: **Links to work:**  your links here
  #100DaysOfCode
---

The template for new cards created in imdone. If you use ${<prop>} syntax, all props and computed props will be permanently interpolated in the card when it’s appended to your journal.
If you want a property to be displayed dynamically in your card then use {{<prop>}} syntax.

:100: Days of code, Day 2: Mon Jan 06 2020
:rocket: **Progress:**  your progress here
:thought_balloon: **Thoughts:**  your thoughts here
:link: **Links to work:**  your links here
#100DaysOfCode

This is what will be in your card editor when you add a card, if the front-matter above is in your markdown file.

tags

front-matter tags will be applied to all cards in the markdown file

context

front-matter contexts will be applied to all cards in the markdown file

meta

front-matter meta will be applied to all cards in the markdown file

Adding languages

To add a programming language for imdone to check for CODE style cards, add a section like this to your .imdone/config.yml so imdone will only look in comments.

To contribute a language extension, fork imdone-core and open a PR.

languages:
  .cs:
    name: cs
    symbol: "//"
    block:
      start: "/*"
      end: "*/"
      ignore: "*"

Ignoring files

.imdoneignore

Imdone will look for one .imdoneignore file at the root of your project.

.imdoneignore is implemented using the ignore package. Each file in your projects path is tested against the rules in these files. To ignore all but some subdirectories, see this Stack Overflow question. git - .gitignore exclude folder but include specific subfolder - Stack Overflow

.imdonepause

Create an empty .imdonepause file at the root of your project to pause the file watcher. This is useful when you need to temporarily stop imdone from watching for file changes in your project.

To resume watching:

  • Delete the .imdonepause file from the root of your project

Alternative: Using imdone-cli You can also pause and resume the file watcher using imdone-cli commands:

  • imdone pause - Pause the file watcher
  • imdone resume - Resume the file watcher