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

help-beta: Convert indented admonitions to asides.

Browse Source 
Fixes https://chat.zulip.org/#narrow/channel/19-documentation/topic/new.20help.20center.3A.20broken.20tip
After indenting asides properly, they became part of lists, so we had to
change Flattenlist to allow asides inside it and ignore comments.
This commit is contained in:
Shubham Padia
2025-07-24 06:20:24 +00:00
committed by Tim Abbott
parent 500e40f786
commit 41846b35ab
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
help-beta/src/components/FlattenList.astro
View File

@@ -23,8 +23,13 @@ assert.ok(
const flattened = { const flattened = {
...first_element, ...first_element,
children: tree_with_removed_newlines.children.flatMap((other) => { children: tree_with_removed_newlines.children.flatMap((other) => {
if (other.type === "comment") {
return [];
}
assert.ok( assert.ok(
other.type === "element" && other.tagName === first_element.tagName, other.type === "element" &&
(other.tagName === first_element.tagName ||
other.tagName === "aside"),
); );
return other.children; return other.children;
}), }),

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

@@ -408,12 +408,13 @@ def convert_admonitions_to_asides(
""" """
Lots of code in this function is taken from Lots of code in this function is taken from
https://github.com/Python-Markdown/markdown/blob/64a3c0fbc00327fbfee1fd6b44da0e5453287fe4/markdown/extensions/admonition.py https://github.com/Python-Markdown/markdown/blob/64a3c0fbc00327fbfee1fd6b44da0e5453287fe4/markdown/extensions/admonition.py
`(?:^|\n)!!!` has been changed to `(?:^|\n)( *)!!!` to allow for indented admonitions to be converted.
""" """
RE = re.compile(r'(?:^|\n)!!! ?([\w\-]+(?: +[\w\-]+)*)(?: +"(.*?)")? *(?:\n|$)') RE = re.compile(r'(?:^|\n)( *)!!! ?([\w\-]+(?: +[\w\-]+)*)(?: +"(.*?)")? *(?:\n|$)')
RE_SPACES = re.compile(" +") RE_SPACES = re.compile(" +")
def get_admonition_class_and_title(match: re.Match[str]) -> tuple[str, str | None]: def get_admonition_class_and_title(match: re.Match[str]) -> tuple[str, str | None]:
klass, title = match.group(1).lower(), match.group(2) klass, title = match.group(2).lower(), match.group(3)
klass = RE_SPACES.sub(" ", klass) klass = RE_SPACES.sub(" ", klass)
if title is None: if title is None:
# no title was provided, use the capitalized class name as title # no title was provided, use the capitalized class name as title
@@ -446,19 +447,17 @@ def convert_admonitions_to_asides(
# implementation. # implementation.
# See https://chat.zulip.org/#narrow/channel/19-documentation/topic/Stage.202.3A.20New.20syntax.20for.20!!!tip.20in.20help-beta/near/2174415 # See https://chat.zulip.org/#narrow/channel/19-documentation/topic/Stage.202.3A.20New.20syntax.20for.20!!!tip.20in.20help-beta/near/2174415
# for more details. # for more details.
replacement = f"\n<ZulipNote>\n{admonition_content}\n</ZulipNote>\n" replacement = f"\n{match.group(1)}<ZulipNote>\n{admonition_content}\n{match.group(1)}</ZulipNote>\n"
import_statement_set.add( import_statement_set.add(
f"import ZulipNote from '{components_dir_path}/ZulipNote.astro';" f"import ZulipNote from '{components_dir_path}/ZulipNote.astro';"
) )
elif klass == "tip": elif klass == "tip":
type = "tip" type = "tip"
title = "Tip" title = "Tip"
replacement = ( replacement = f'\n{match.group(1)}<Aside type="{type}" title="{title}">\n{admonition_content}\n{match.group(1)}</Aside>\n'
f'\n<Aside type="{type}" title="{title}">\n{admonition_content}\n</Aside>\n'
)
import_statement_set.add("import { Aside } from '@astrojs/starlight/components'") import_statement_set.add("import { Aside } from '@astrojs/starlight/components'")
elif klass == "keyboard_tip": elif klass == "keyboard_tip":
replacement = f"\n<KeyboardTip>\n{admonition_content}\n</KeyboardTip>\n" replacement = f"\n{match.group(1)}<KeyboardTip>\n{admonition_content}\n{match.group(1)}</KeyboardTip>\n"
import_statement_set.add( import_statement_set.add(
f"import KeyboardTip from '{components_dir_path}/KeyboardTip.astro';" f"import KeyboardTip from '{components_dir_path}/KeyboardTip.astro';"
) )