Skip to content

Update template-anatomy.md #10

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.

Sign up for GitHub

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

Open
mcolacino57 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update template-anatomy.md #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/templating-basics/template-anatomy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ sidebar_position: 2
---

# Template Anatomy
`np.Templating` template use format called [Frontmatter](https://jekyllrb.com/docs/front-matter/) which is commonly found in blogging platforms which utilizes templates to render dynamic content and is a great fit for the way NotePlan integrates normal note taking features, but infuses a robust calendaring system.
The `np.Templating` template uses a format called [Frontmatter](https://jekyllrb.com/docs/front-matter/) commonly found in blogging platforms that utilize templates to render dynamic content. It is a great fit for the way NotePlan integrates normal note taking features, but infuses a robust calendaring system.

### Template Configuration
There are two parts to a NotePlan template, template attributes, and template body.
There are two parts to a NotePlan template: template attributes and template body.

![NotePlan Event](/img/noteplan-default-template.png)

`attributes` - The attribute section is between open `---` and closing `---` tags. The attributes will have at least two properties `title` and `type`. NotePlan will display the frontmatter attributes in an alternate tint color

`body` - The remainder of template, after the second delimiter line`---` is the template content and will be use when template is rendered.
`body` - The remainder of template, after the second delimiter line`---`, is the template content and will be used when the template is rendered.

**Example**

Expand All @@ -33,7 +33,7 @@ And the remainder of the template will be display here ...
```

### Using Dynamic Keys
If you wish to have dynamic templates which use frontmatter tags, you can use the following syntax
If you wish to have dynamic templates which use frontmatter tags, you can use the following syntax:

- Use `{%` and `%}` template tags in desired frontmatter attribute (see `modified`)
- Use `<%- frontmatter.attributeName %>` syntax to access frontmatter attributes within template content (see `modified` reference in template)
Expand Down