📖 Markdown Formatting Rules

To ensure your test cases are correctly parsed and displayed in Assert.True, please follow these structure rules.

1. Metadata Tags

Metadata tags provide high-level information about the test suite. They appear in a dedicated header card at the top.

• Mandatory: --name, --author, --version
• Optional: --description, --date, --tags
• Example:

  --name Test Suite Name
  --author Author Name
  --version 1.0.0
  --date 07/05/2026
  --tags Frontend, Dashboard, UI
  --description Description of the test suite

2. Preconditions

Preconditions are informational items that apply to all tests. They appear in a special highlighted card at the very top of the list.

• Format: Use ### [Preconditions] or **Preconditions** as a header, followed by a bulleted list.
• Example:

  ### [Preconditions]
  - User is logged in as Admin
  - Project has at least one active transaction

2. Test Case Header

Every test must start with a level 3 heading (###) containing the [Test] keyword. You can optionally include a test number and a description.

• Format: ### [Test n - Description]
• Example: ### [Test 1 - Login Functionality]

2. Steps

Steps define the actions to be taken. They should be bullet points starting with the [Step] keyword.

• Format: - [Step] Description of the step
• Example: - [Step] Enter username and password

3. Checks (Expected Results)

Checks define what needs to be verified after a step. They must be nested under a step and start with the [Check] keyword.

• Format: - [Check] What to verify
• Example: - [Check] The dashboard should be visible

4. Text Formatting

You can use standard Markdown bold syntax to emphasize text within steps or checks.

• Syntax: **text to be bold**
• Example: - [Step] Click the **Submit** button

5. Status Markers (Importing Results)

When importing a file that was previously exported, the tool looks for [Pass] or [Fail] markers inside the checks.

• Format: - [Check] [Pass] Description

Full Example

### [Test 1 - Basic Auth]
- [Step] Open the login page
- [Step] Enter **admin** as credentials
  - [Check] The login should be **successful**
  - [Check] User should be redirected to /home

### [Test 2 - Empty Fields]
- [Step] Click Login without entering data
  - [Check] An error message should appear