Persist Blocks

Persist Blocks

Persist blocks allow you to add your own custom notes to GitHub issue and PR files without them being overwritten during sync.

Basic Usage

{% persist "notes" %}
## My Notes

- Your custom content here
- Will never be overwritten!

{% endpersist %}

How It Works

1. Smart Updates: Files are only updated if GitHub data has changed (checks the updated field)
2. Content Protection: Everything inside persist blocks is preserved during sync
3. Position Preservation: Blocks stay exactly where you placed them using surrounding text as anchors

Syntax

{% persist "block-name" %}
Your content here...
{% endpersist %}

• Block names must be unique within each file
• Use descriptive names like "notes", "todos", "analysis"

Multiple Blocks

You can have multiple persist blocks in one file:

{% persist "notes" %}
## My Notes

General thoughts about this issue...

{% endpersist %}

{% persist "todos" %}
## My Tasks

- [ ] Review code
- [ ] Test locally
- [x] Read description

{% endpersist %}

{% persist "related" %}
## Related

- [[Other Issue]]
- [[Project Notes]]

{% endpersist %}

Template Example

Add persist blocks to your content template:

---
title: "{title_yaml}"
number: {number}
---

# {title}

{body}

{comments}

{% persist "notes" %}
## Notes

{% endpersist %}

Tips

1. Place at the end - Putting persist blocks at the end of your template is safest
2. Use meaningful names - Makes it clear what each block is for
3. Don't nest blocks - Persist blocks cannot be nested inside each other
4. Keep formatting simple - Complex formatting might affect position detection