Skip to content

Improve example rendering of parameters and nested functions#7011

Merged
laurmaedje merged 6 commits intomainfrom
example-handling
Oct 7, 2025
Merged

Improve example rendering of parameters and nested functions#7011
laurmaedje merged 6 commits intomainfrom
example-handling

Conversation

@reknih
Copy link
Member

@reknih reknih commented Oct 3, 2025

This PR changes the presentation of examples for nested functions and parameters.

Previously, this was the behavior:

  • Examples for nested functions got pulled below the summary
  • Examples for parameters were collapsed at the end of its docs, below the default

Furthermore, the first instance of three backticks started the example, and all of the markup below was pulled into the collapsible widget or below the summary.

Now, examples appear in reading order. They terminate after their code fence ends, normal text can be below them. They are always in collapsible drawers, but for a nested function, the first example is expanded by default. Furthermore, examples can now be disambiguated with titles by using the :"Example title" syntax in the code fence tag.

This PR introduces some example titles.

Parameter with multiple examples:

Parameter with multiple examples

Nested function with multiple examples
Nested function with multiple examples

Fixes #6922

@laurmaedje laurmaedje enabled auto-merge October 7, 2025 11:50
@laurmaedje laurmaedje added this pull request to the merge queue Oct 7, 2025
Merged via the queue into main with commit f05ef77 Oct 7, 2025
16 checks passed
@laurmaedje laurmaedje deleted the example-handling branch October 7, 2025 11:59
YDX-2147483647 added a commit to YDX-2147483647/typst-docs-web that referenced this pull request Oct 13, 2025
- Unify details/example as `DetailsBlock`: typst/typst#7011
- Add `global_attributes` to `GroupBody`: typst/typst#7083
- Change codepoint to string in `Symbol`: typst/typst#6489
- Add `deprecation_until`: typst/typst#6617

Relates-to: typst-community#15
YDX-2147483647 added a commit to YDX-2147483647/typst-docs-links that referenced this pull request Oct 16, 2025
YDX-2147483647 added a commit to YDX-2147483647/typst-docs-web that referenced this pull request Oct 23, 2025
- Unify details/example as `DetailsBlock`: typst/typst#7011
- Add `global_attributes` to `GroupBody`: typst/typst#7083
- Change codepoint to string in `Symbol`: typst/typst#6489
- Add `deprecation_until`: typst/typst#6617

Relates-to: typst-community#15
YDX-2147483647 added a commit to YDX-2147483647/typst-docs-web that referenced this pull request Oct 24, 2025
- Unify details/example as `DetailsBlock`: typst/typst#7011
- Add `global_attributes` to `GroupBody`: typst/typst#7083
- Change codepoint to string in `Symbol`: typst/typst#6489
- Add `deprecation_until`: typst/typst#6617

Relates-to: typst-community#15
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.

Parameter details after the first example are collapsed by mistake

2 participants