Skip to content

Note Syntax

Learn JodNote's simple syntax for organizing notes with types, categories, and markers.

Overview

JodNote uses inline text markers instead of dropdown menus or buttons. Just type your note naturally with special markers, and JodNote handles the rest.

Note Types

Regular Notes (Default)

Any text without a type marker is a regular note:

Meeting with Sarah tomorrow at 3pm
Ideas for the blog post

Characteristics:

  • Default type when no marker present
  • Best for general notes, thoughts, ideas
  • Can still use categories with #tags

Tasks

Create tasks using either method:

Method 1: > Prefix

> Buy groceries
> Call dentist on Friday
> Finish project report

Method 2: @task Marker

Submit expense report @task
Review pull requests @task

Characteristics:

  • Can be checked off as complete
  • Shows checkbox in UI
  • Both methods work identically
  • > prefix auto-adds @task internally

Recommended

Use > prefix for speed. Type @task when converting existing notes.

Code Snippets

Use @snippet for code or reusable text:

git status @snippet
console.log('debug') @snippet
SELECT * FROM users @snippet #sql
def factorial(n): return 1 if n <= 1 else n * factorial(n-1) @snippet #python

Characteristics:

  • Monospace font in UI
  • Syntax highlighting (if category matches language)
  • Easy to copy and reuse
  • Great for commands, code, scripts

Best Practices:

npm install package @snippet #npm
docker ps -a @snippet #docker
curl -X POST https://api.com @snippet #api

Bookmarks

Use @bookmark for links and references:

https://docs.example.com @bookmark
https://github.com/techformist/jodnote @bookmark #github
https://stackoverflow.com/questions/12345 @bookmark #reference

Characteristics:

  • URLs automatically detected (even without @bookmark)
  • Click to open in browser
  • Can include description before URL

Examples:

React documentation https://react.dev @bookmark #docs
Favorite recipe https://recipes.com/chocolate-cake @bookmark #cooking

Auto-Detection

Links starting with http:// or https:// are automatically recognized as URLs even without @bookmark.

Categories

Add categories with # hashtags:

Meeting notes #work
Buy milk #personal
Git cheat sheet @snippet #git
Project deadline tomorrow #work #urgent

Rules:

  • Multiple categories allowed
  • Case-insensitive (#Work = #work)
  • Alphanumeric characters only
  • No spaces (use #ProjectX not #Project X)

Common Categories:

#work        - Work-related notes
#personal    - Personal tasks/notes
#idea        - Ideas and brainstorming
#urgent      - High-priority items
#reference   - Reference material
#code        - Code-related notes
#meeting     - Meeting notes

Combining Elements

Mix types, categories, and content freely:

> Review PR #45 @task #work #urgent
function sleep(ms) { return new Promise(r => setTimeout(r, ms)) } @snippet #javascript
Holiday planning ideas #personal #travel
https://api-docs.com/auth @bookmark #docs #api

Syntax Rules

Order Doesn't Matter

These are all equivalent:

Buy groceries > #personal
#personal > Buy groceries
> #personal Buy groceries

Recommended Order

Content text > @type #category

This reads most naturally.

Multiple Markers

  • Multiple categories: #work #urgent #client
  • Multiple types: Only one type per note (first wins)
✅ Correct: Fix bug @task #work #urgent
❌ Incorrect: Meeting notes @task @snippet (task wins)

Whitespace

Spaces around markers are optional:

Buy milk> #personal     ✅ Works
Buy milk > #personal    ✅ Works (more readable)
Buy milk>#personal      ✅ Works

Examples by Use Case

Task Management

> Submit report by Friday #work
> Book dentist appointment #personal
> Review code before merge @task #urgent
> Plan weekend trip #personal #travel

Code Snippets

npm run build @snippet #npm
git reset --hard HEAD @snippet #git
docker-compose up -d @snippet #docker
SELECT * FROM users WHERE active=1 @snippet #sql
https://vuejs.org/guide @bookmark #docs
https://github.com/tauri-apps/tauri @bookmark #tauri
API documentation https://api.example.com/docs @bookmark #work

Mixed Notes

Meeting agenda #work
- Discuss project timeline
- Review budget @task
- Assign tasks to team

Code review checklist @snippet #dev
- Tests passing?
- Documentation updated?
- No console.logs

Weekend todo #personal
> Grocery shopping
> Clean garage
> Call mom

Smart Parsing

JodNote parses your text in real-time:

As You Type

User types: Buy milk
JodNote:    Regular note

User types: Buy milk >
JodNote:    Task note (detects > prefix)

User types: Buy milk > #
JodNote:    Task note, waiting for category

User types: Buy milk > #personal
JodNote:    Task note, category: personal

URL Detection

User types: Check out https://example.com
JodNote:    Automatically detects URL, suggests @bookmark

Type Markers

@task      → Task note (checkbox in UI)
@snippet   → Code snippet (monospace font)
@bookmark  → Bookmark (link icon)

Visual Feedback

JodNote provides visual cues:

  • Tasks: Checkbox, strike-through when complete
  • Snippets: Monospace font, syntax highlighting
  • Bookmarks: Link icon, clickable
  • Categories: Colored badges, filterable
  • URLs: Clickable links

Migration from Other Apps

From Plain Text

Just paste your text. Add markers as needed:

Before: TODO: Buy groceries
After:  > Buy groceries #personal

From Markdown

Before: - [ ] Task item
After:  > Task item

Before: `code snippet`
After:  code snippet @snippet

From Other Note Apps

  • OneNote/Evernote: Copy text, add #categories
  • Notion: Use #tags for databases, @task for checkboxes
  • Apple Notes: Add markers for better organization

Best Practices

Be Consistent

Choose a style and stick with it:

✅ Good:
> Buy milk #personal
> Call doctor #personal
> Pay bills #personal

❌ Inconsistent:
Buy milk > #personal
Call doctor @task #personal
> #personal Pay bills

Use Descriptive Categories

✅ Good: #work #client-acme #urgent
❌ Vague: #stuff #things #misc

Keep It Simple

Don't over-categorize:

✅ Good: Meeting notes #work
❌ Too much: Meeting notes #work #meeting #internal #q4 #team

Natural Language

Write notes naturally, add markers:

✅ Good: > Finish the quarterly report by Friday #work
❌ Awkward: #work @task Friday quarterly report finish

Syntax Quick Reference

SyntaxMeaningExample
>Task (prefix)> Buy milk
@taskTask (explicit)Call mom @task
@snippetCode snippetgit status @snippet
@bookmarkBookmarkhttps://example.com @bookmark
#wordCategoryMeeting #work
http://Auto-detected URLhttps://example.com

Learn More

Released under the MIT License.