IxDF Developer Docs

Appearance

Markdown Formatting Guide ​

Status: Draft

Scope: Internal documentation (Nova Help Cards). Does not cover public-facing content or API docs. Context: Slack discussion

This guide covers Markdown formatting rules. See also:

Table of Contents ​

Rules ​

These rules require human attention. Spacing and other minor issues are auto-fixed by rumdl fmt.

⚙️ Technical: rumdl

You can use make md:fix locally to run it. This auto-fixes: trailing whitespace, list indentation, double spaces, blank lines, trailing newlines, bare URLs.

1. No Punctuation in Headings ​

Headings should not end with colons, question marks, or other punctuation.

markdown
<!-- Bad -->
### How to Use This Page:
### Viewing Details:

<!-- Good -->
### How to Use This Page
### Viewing Details

2. Term Definitions ​

When defining a term, use bold for the term and continue with the definition.

markdown
<!-- Bad -->
**What a Credit Note is**

A Credit Note is a financial document...

<!-- Good -->
**Credit Note** is a financial document...

3. Do Not Mix Markdown and HTML ​

Use Markdown syntax consistently. Do not use HTML tags like <b>, <i>, <a> when Markdown equivalents exist.

markdown
<!-- Bad -->
Open the <b>Member Details</b> page.
See the <a href="/admin/nova">Nova panel</a> for more.
This is <i>important</i> information.

<!-- Good -->
Open the **Member Details** page.
See the [Nova panel](/admin/nova) for more.
This is *important* information.
HTMLMarkdown equivalent
<b>text</b>**text**
<i>text</i>*text*
<a href="url">text</a>[text](url)

Tips ​

Break Long Lines ​

Markdown only creates a new paragraph when there's a blank line. A single line break is ignored, so you can split long sentences for readability in the source file.

markdown
<!-- This renders as ONE paragraph -->
This is a long sentence that describes something important
about the Resource and how it works in Nova.

<!-- This renders as TWO paragraphs -->
This is the first paragraph.

This is the second paragraph.

Resources ​