paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 21:43:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

help-beta: Add support for converting {{ support_email }} variable.

Browse Source 
Fixes
https://chat.zulip.org/#narrow/channel/19-documentation/topic/new.20help.20center.3A.20support.20email.20variable.20conversion

We already have this variable defined in astro.config.mjs. We just need
to convert it to appropriate syntax.
This commit is contained in:
Shubham Padia
2025-07-29 14:29:28 +00:00
committed by Tim Abbott
parent cb8ecc6143
commit 8d0f67c3d5
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
tools/convert-help-center-docs-to-mdx
View File

@@ -472,6 +472,18 @@ def convert_admonitions_to_asides(
return replace_with_mdx_syntax(markdown_string) return replace_with_mdx_syntax(markdown_string)
def convert_env_variables(markdown_string: str, import_statement_set: set[str]) -> str:
# We run this step after we've escaped braces.
if r"\{\{ support_email \}\}" in markdown_string:
# This variable has already been declared in astro.config.mjs.
import_statement_set.add('import {SUPPORT_EMAIL} from "astro:env/client";')
markdown_string = markdown_string.replace(
r"\{\{ support_email \}\}", "<>{SUPPORT_EMAIL}</>"
)
return markdown_string
def insert_imports(markdown_string: str, import_statement_set: set[str], line_number: int) -> str: def insert_imports(markdown_string: str, import_statement_set: set[str], line_number: int) -> str:
if len(import_statement_set) == 0: if len(import_statement_set) == 0:
return markdown_string return markdown_string
@@ -548,6 +560,7 @@ def convert_help_center_file_to_mdx(
result = replace_image_path(result, "../../../../static/images/help") result = replace_image_path(result, "../../../../static/images/help")
result = replace_icons(result, import_statement_set) result = replace_icons(result, import_statement_set)
result = convert_comments(result) result = convert_comments(result)
result = convert_env_variables(result, import_statement_set)
result = insert_imports(result, import_statement_set, 2) result = insert_imports(result, import_statement_set, 2)
result = insert_frontmatter(result) result = insert_frontmatter(result)
return result return result
@@ -594,6 +607,7 @@ def convert_include_file_to_mdx(
result = replace_image_path(result, "../../../../../static/images/help") result = replace_image_path(result, "../../../../../static/images/help")
result = replace_icons(result, import_statement_set) result = replace_icons(result, import_statement_set)
result = convert_comments(result) result = convert_comments(result)
result = convert_env_variables(result, import_statement_set)
result = insert_imports(result, import_statement_set, 1) result = insert_imports(result, import_statement_set, 1)
return result return result