Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feature: support examples in code blocks (#82) #83

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

vecerek
Copy link
Contributor

@vecerek vecerek commented Nov 2, 2024

Type

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

This PR implements support for @example tags that contain code enclosed in (extended) Markdown code blocks, or fenced code blocks. Fenced code blocks either use 3 backticks ``` or 3 tildes ~~~.

Screenshot of the shiki popup after the change:

Screenshot 2024-11-03 at 07 27 20

Related

Copy link

changeset-bot bot commented Nov 2, 2024

🦋 Changeset detected

Latest commit: 4fdf6b1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@effect/docgen Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@IMax153
Copy link
Member

IMax153 commented Nov 4, 2024

@gcanti - this PR looks good to me, what do you think?

@IMax153 IMax153 requested a review from gcanti November 4, 2024 21:01
@gcanti gcanti merged commit fcd5649 into Effect-TS:main Nov 5, 2024
6 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support examples enclosed in MD code block
3 participants