-
Notifications
You must be signed in to change notification settings - Fork 140
Enhance documentation for Nunjucks variables #2764
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Add docs for basic usage and escaping syntax
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
There was a problem hiding this 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.
|
Updated documentation here: https://deploy-preview-2764--markbind-master.netlify.app/userguide/reusingcontents#basic-usage-of-variables |
|
@gerteck Each PR must have a SEMVER impact label, please remember to label the PR properly. |
Add docs for basic usage and escaping syntax
What is the purpose of this pull request?
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: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
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):