Skip to content

Conversation

@alondmnt
Copy link
Collaborator

Documentation Update & Demo Template

Summary

Major documentation overhaul to document all features added since v2.4.0, including advanced Handlebars helpers, notebook-specific defaults, mobile support, and new special variables. Added comprehensive demo template with syntax fixes.

Changes

1. Code Quality

  • Fixed linting: Standardized string quotes to double quotes across 6 files (19 instances)
  • Removed inferrable type annotation in templates.ts

2. Documentation (README.md)

  • Added complete documentation for 6 Handlebars helpers (compare, condition, math, case, repeat, datetime)
  • Documented template_todo_alarm special variable (previously undocumented)
  • Expanded Default Templates section with notebook-specific defaults guide
  • Added Mobile Support section with platform-specific guidance
  • Updated Table of Contents with new sections

3. Demo Template (DEMO_TEMPLATE.md)

  • Created comprehensive feature demonstration template showcasing all plugin capabilities
  • Includes 8 custom variables, all helpers, special variables, and real-world examples
  • Fixed YAML syntax issues (proper quoting for special characters)
  • Fixed datetime formats (set_time without seconds, template_todo_alarm as YYYY-MM-DD HH:mm)
  • Fixed condition helper usage (replaced incorrect NOT with Handlebars {{#unless}})
  • Fixed template_tags quoting to prevent HTML entity encoding

Impact

  • All features since v2.4.0 now documented
  • Demo template for testing and learning
  • Improved user onboarding with clear examples and guidance

@laurent22 laurent22 merged commit 077af63 into joplin:master Oct 25, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants