Skip to content

Conversation

@gerteck
Copy link
Member

@gerteck gerteck commented Dec 25, 2025

Add docs for basic usage and escaping syntax

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:

Add some basic variable syntax into the user guide so it is easier to get started without already being familiar with nunjucks and their templates.

No particular issue, but found the user guide lacking in this aspect as in what would have been useful to me when adding feature that supports nunjucks.

Anything you'd like to highlight/discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)

Enhance docs for Nunjucks variables

Add docs for basic usage and escaping syntax


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

Add docs for basic usage and escaping syntax
@codecov
Copy link

codecov bot commented Dec 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.65%. Comparing base (dc7263e) to head (c165ee1).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #2764    +/-   ##
========================================
  Coverage   61.65%   61.65%            
========================================
  Files         130      130            
  Lines        7167     7167            
  Branches     1573     1505    -68     
========================================
  Hits         4419     4419            
+ Misses       2685     2558   -127     
- Partials       63      190   +127     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request enhances the Nunjucks variables documentation by adding introductory content to help users get started with basic variable usage and syntax escaping. The changes provide essential information that was previously missing, making the documentation more accessible to users unfamiliar with Nunjucks.

  • Adds a "Basic Usage of Variables" section with a practical example of defining and using variables
  • Introduces an "Escaping Nunjucks Syntax" subsection explaining how to display Nunjucks syntax literally
  • Provides guidance on variable naming conventions and case sensitivity

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gerteck
Copy link
Member Author

gerteck commented Dec 25, 2025

@gerteck gerteck merged commit 024b2ce into MarkBind:master Dec 25, 2025
10 checks passed
@github-actions
Copy link

@gerteck Each PR must have a SEMVER impact label, please remember to label the PR properly.

@gerteck gerteck added r.Patch Version resolver: increment by 0.0.1 a-Documentation 📝 labels Dec 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a-Documentation 📝 r.Patch Version resolver: increment by 0.0.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant