Documentation

Rich Text Notes for Jira

A dashboard gadget for formatted notes: headings, lists, checklists you can tick from the dashboard, links, quotes and code. Matches Jira’s light and dark themes.

Get it on the Marketplace Support

Install

A Jira site administrator installs the app from the Atlassian Marketplace (Apps → Explore more apps → search “Rich Text Notes”).
Open any dashboard you can edit and choose Add gadget.
Search for Rich Text Notes and add it. The gadget appears empty with a hint to edit it.

Write a note

Open the gadget menu (···) and choose Edit.
Write using the toolbar or Markdown-style shortcuts: # heading, - bullet list, 1. numbered list, [ ] checklist, > quote, ``` code block.
Press Save. The note is stored and shown to everyone who can see the dashboard.

Formatting	Shortcut
Bold / Italic / Underline	Ctrl+B / Ctrl+I / Ctrl+U (Cmd on Mac)
Strikethrough / Inline code	Toolbar
Headings 1–3	`#`, `##`, `###` followed by a space
Bullet / numbered list	`-` or `1.` followed by a space
Checklist	`[ ]` followed by a space
Quote / code block / divider	`>`, ```, `---`
Link	Select text and use the link button; paste a URL to link it automatically
Undo / Redo	Ctrl+Z / Ctrl+Shift+Z

Checklists on the dashboard

Checklist items can be ticked directly in the dashboard view, without opening the editor. Each change is saved immediately and visible to everyone viewing the dashboard. Ticked items are shown struck through.

Permissions and who can edit

Anyone who can edit the dashboard can edit the note; anyone who can view the dashboard can read it and tick checklist items. The gadget follows Jira’s dashboard permissions and adds none of its own.

Limits

One note per gadget. Add more gadgets for more notes.
A note can hold up to 100 KiB of formatted text, roughly 15,000 words. The editor tells you if you reach the limit.
Notes are text only. Images and attachments are not supported in this version.
Copying a dashboard creates new gadgets with empty notes; notes are not duplicated.

Where your data lives

Notes are stored in Atlassian’s Forge hosted storage, inside your Atlassian site’s data boundary. The app has no servers of its own and sends nothing outside Atlassian. See the privacy policy for details.

Uninstalling the app removes the gadgets from dashboards. Stored notes are deleted according to Atlassian’s Forge storage retention after uninstall.

Troubleshooting

Symptom	What to check
The gadget shows “Loading…” for a long time	Reload the page. If it persists, the app may still be installing; wait a minute and try again.
“Could not load this note”	Your account may lack permission on this dashboard, or the app was uninstalled and reinstalled. Contact your Jira admin, then us.
Formatting looks wrong in dark mode	Reload once after switching themes. If it stays wrong, send us a screenshot.
The gadget does not appear in “Add gadget”	Confirm the app is installed (Apps → Manage apps) and refresh the dashboard.

Changelog

1.0 — First release: formatted notes, interactive checklists, links, light and dark themes.