paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 22:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

help-beta: Adjust icon class names in the conversion process.

Browse Source 
Use the icon's name, in camelcase, with the suffix "Icon" for
icon class names in the new help center documentation. E.g.,
zulip-icon-external-link becomes ExternalLinkIcon and fa fa-plus
becomes PlusIcon.
This commit is contained in:
Lauryn Menard
2025-08-01 17:04:51 +02:00
committed by Tim Abbott
parent e5864eb103
commit 9a25e97c40
1 changed files with 3 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -154,11 +154,10 @@ def insert_string_at_line(text: str, destination_str: str, n: int) -> str:
def replace_icon_with_unplugin_component( def replace_icon_with_unplugin_component(
match: re.Match[str], match: re.Match[str],
icon_package_name: str, icon_package_name: str,
icon_component_prefix: str,
import_statement_set: set[str], import_statement_set: set[str],
) -> str: ) -> str:
icon_name = match.group(1) icon_name = match.group(1)
component_name = icon_component_prefix + to_pascal(icon_name).replace("-", "") component_name = to_pascal(icon_name).replace("-", "") + "Icon"
import_statement = f'import {component_name} from "~icons/{icon_package_name}/{icon_name}"' import_statement = f'import {component_name} from "~icons/{icon_package_name}/{icon_name}"'
import_statement_set.add(import_statement) import_statement_set.add(import_statement)
return f"<{component_name} />" return f"<{component_name} />"
@@ -174,7 +173,7 @@ def replace_icons(markdown_string: str, import_statement_set: set[str]) -> str:
) )
def replace_font_awesome_icon_with_unplugin_component(match: re.Match[str]) -> str: def replace_font_awesome_icon_with_unplugin_component(match: re.Match[str]) -> str:
return replace_icon_with_unplugin_component(match, "fa", "Fa", import_statement_set) return replace_icon_with_unplugin_component(match, "fa", import_statement_set)
result = re.sub( result = re.sub(
font_awesome_pattern, replace_font_awesome_icon_with_unplugin_component, markdown_string font_awesome_pattern, replace_font_awesome_icon_with_unplugin_component, markdown_string
@@ -185,9 +184,7 @@ def replace_icons(markdown_string: str, import_statement_set: set[str]) -> str:
) )
def replace_zulip_icon_with_unplugin_component(match: re.Match[str]) -> str: def replace_zulip_icon_with_unplugin_component(match: re.Match[str]) -> str:
return replace_icon_with_unplugin_component( return replace_icon_with_unplugin_component(match, "zulip-icon", import_statement_set)
match, "zulip-icon", "ZulipIcons", import_statement_set
)
result = re.sub(zulip_icon_pattern, replace_zulip_icon_with_unplugin_component, result) result = re.sub(zulip_icon_pattern, replace_zulip_icon_with_unplugin_component, result)