Dceniac Labs

Dceniac Markdown Writer for Jira — Documentation

User & Administrator Guide · Jira Cloud & Jira Service Management

Overview: Dceniac Markdown Writer for Jira adds a live-preview Markdown editor directly to Jira Cloud issues and Jira Service Management work items. Write or paste Markdown (including output from ChatGPT, Claude, GitHub, or technical docs) and save it as native Jira formatting — complete with tables, checklists, code blocks, panels, @mentions, image attachments, and editable Mermaid diagrams.

Architecture: 100% Runs on Atlassian (Forge). No external servers, databases, or third-party analytics — your issue content never leaves your Jira site.

Contents: 1. Installation 2. How to Access & Test 3. Descriptions & Comments 4. Markdown & Toolbar 5. Mentions, Images & Mermaid 6. Conflict Protection & Drafts 7. Permissions & Licensing

1. Installation & Prerequisites

  1. Sign in to your Jira Cloud site as a Jira administrator.
  2. In the top navigation bar, select Apps → Explore more apps.
  3. Search for Dceniac Markdown Writer for Jira and click Try it free (or Get it now — free for teams of up to 10 users).
  4. Confirm installation. No post-install configuration screen or external API key is required; the app is immediately available on every Jira Software, Jira Work Management, and Jira Service Management issue.

2. How to Access & Test the App

Once installed, open any Jira issue (for example, PROJ-1). You can launch Dceniac Markdown Writer for Jira from two built-in entry points:

  1. Issue Sidebar Panel (One-Click Entry): Look at the right-hand sidebar of the issue view (under Details / Context panels) and find Dceniac Markdown Writer for Jira (if not yet expanded on the issue, click the Write in Markdown action button to reveal it). Choose:
    • Edit description — opens the modal directly on the current issue description.
    • Comment (or Internal note on Jira Service Management requests) — opens the modal directly in new-comment mode.
  2. Issue More Actions (•••) Menu: Click the ••• button in the top-right corner of any Jira issue and click Edit in Markdown.
Dceniac Markdown Writer for Jira split-pane modal editing a Jira issue description
Split-view modal editing an issue description on the left with synchronized Jira-styled preview on the right.

3. Editing Descriptions, Comments & JSM Notes

Writing a Jira comment with checklists, tables, panels, and @mention autocomplete
Comment mode showing user @mention search, task checkboxes, tables, and a GitHub-style [!TIP] panel.

4. Markdown Syntax, Live Preview & Shortcuts

Use the layout switcher on the right side of the formatting toolbar to choose Write (editor only), Split (side-by-side with synchronized scrolling), or Preview (rendered output only). When opening an empty field, click Try with sample Markdown on the welcome card to test all supported formatting in one click.

Markdown SyntaxSaved Jira OutputShortcut / Toolbar
# H1 … ###### H6Native Jira headings (levels 1–6)Toolbar H1 H2 H3
**bold**, *italic*, ~~strike~~Bold, italic, strikethrough textCtrl/⌘+B, Ctrl/⌘+I, Ctrl/⌘+Shift+X
`inline code`Monospace inline codeCtrl/⌘+E
[label](https://…)Clickable linkCtrl/⌘+K
- item / 1. itemBulleted and numbered lists (nested supported)List toolbar buttons
- [ ] todo / - [x] doneInteractive Jira action items (checklists)Checklist toolbar button
GFM pipe tables (| Col | Col |)Native Jira tablesTable toolbar button
```ts … ```Syntax-highlighted Jira code blockCode block toolbar button
> [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION]Native Jira Info, Success, Note, Warning, and Error panelsInfo panel toolbar button
> quote and ---Blockquote and horizontal dividerQuote & Divider buttons

5. @Mentions, Images & Mermaid Diagrams

Mermaid flowchart rendered live inside Dceniac Markdown Writer for Jira alongside preserved Jira attachments
Live Mermaid flowchart rendering and atomic preservation of existing Jira attachments.

6. Content Safety, Conflict Protection & Local Drafts

7. Permissions, Data Privacy & Troubleshooting