Markdown search index (issue entity property)

Markdown for Jira keeps a small search index on every issue that holds a Markdown document. It is what lets the Capable Markdown page list documents across projects, and what lets you find those issues with JQL.


#What the index holds

JQL field

What it holds

Type

<prefix>_markdown_count

How many .md attachments the issue has.

Number

<prefix>_markdown_updated

When the newest .md attachment was added. Saving an edit counts, because it uploads a fresh file.

Date

Both field names start with a short code that is unique to the app. Start typing markdown_count in Jira's advanced issue search and pick the full name from the suggestions. The Capable Markdown page runs the same kind of search:

<prefix>_markdown_count > 0 ORDER BY <prefix>_markdown_updated DESC

#When it updates

  • Each time a .md file is added to or removed from an issue, the app recounts every .md attachment on that issue. It does not matter whether the file came through the Markdown panel or through Jira's own attachment control.

  • Updates only happen while the app is installed and licensed.

  • There is no backfill. Files that were already on an issue when the app was installed are counted the next time a .md file is added to or removed from that issue.

  • Files are recognised by their .md extension, in upper or lower case.


#Where to find it

Stored on each Jira issue


#Where you do it

Task

Where

Find issues that hold Markdown

Jira issue search, in advanced (JQL) mode

Browse Markdown across projects

Jira > Apps > Capable Markdown

Check the licence is active

Jira > Apps > Manage apps


#Settings that affect this

Setting

Where

What it does

Project filter

Apps > Capable Markdown > project selector

Adds a project condition to the page's search, so only the projects you pick are listed. It is not saved when you leave the page.


#A few things that catch people out

  • The Capable Markdown page and JQL only see issues the index has recorded, so files added before the app was installed, or while it was unlicensed, are missing until that issue's Markdown changes.

  • When the last .md file is removed from an issue, its count drops to 0 and the date is cleared, so the issue no longer matches > 0.

  • A file attached by hand with an upper-case extension, such as README.MD, is counted and shows in the panel, but the Capable Markdown page leaves it out of its list. Documents saved from the panel always use a lower-case .md.



How it actually behaves.