Skip to content

fix: clairify the helptext that markdown is supported with a warning about HTML indentation#6747

Merged
CommanderStorm merged 5 commits intolouislam:masterfrom
iyawnnn:fix/status-page-helptext
Jan 16, 2026
Merged

fix: clairify the helptext that markdown is supported with a warning about HTML indentation#6747
CommanderStorm merged 5 commits intolouislam:masterfrom
iyawnnn:fix/status-page-helptext

Conversation

@iyawnnn
Copy link
Copy Markdown
Contributor

@iyawnnn iyawnnn commented Jan 16, 2026

Description

Fixes #6180

This PR adds a help text to the "Description" and "Footer Text" fields in the Status Page edit screen. It warns users that adding leading spaces to HTML content will cause formatting issues (due to the Markdown parser interpreting indentation as code blocks).

Changes

  • UI Update: Added a warning message below the Description and Footer Text text areas in src/pages/StatusPage.vue.
  • Localization: Added the htmlIndentationWarning key to src/lang/en.json to ensure the text is translatable.

Reasoning

Users frequently paste indented HTML into these fields, which causes the content to be rendered as a code block or with broken formatting due to Markdown rules. This help text clarifies the behavior directly in the UI.

Type of change

  • Enhancement (non-breaking change which improves UX)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

Copy link
Copy Markdown
Collaborator

@CommanderStorm CommanderStorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change markdownSupported instead of adding a new translation key for this.
It is much simpler to translate this way, especially for RTL languages.

@CommanderStorm CommanderStorm changed the title fix: add helptext warning about HTML indentation (#6180) fix: clairify the helptext that markdown is supported with a warning about HTML indentation Jan 16, 2026
Copy link
Copy Markdown
Collaborator

@CommanderStorm CommanderStorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, LGTM

@CommanderStorm CommanderStorm enabled auto-merge (squash) January 16, 2026 04:46
@CommanderStorm CommanderStorm merged commit f470b01 into louislam:master Jan 16, 2026
25 checks passed
@iyawnnn iyawnnn deleted the fix/status-page-helptext branch January 16, 2026 04:51
@CommanderStorm CommanderStorm added this to the 2.1.0 milestone Jan 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

improve helptexts around formatting in the footer/header description boxes

2 participants