search

Effect-TS / docgen

An opinionated documentation generator for Effect projects
https://effect-ts.github.io/docgen
MIT License
36 stars 8 forks source link

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

Closed vecerek closed 3 weeks ago

vecerek commented 3 weeks ago

Type

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

changeset-bot[bot] commented 3 weeks ago

🦋 Changeset detected

Latest commit: 4fdf6b177c3f791c44726ca3f38fe231d9b00e1b

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 commented 3 weeks ago

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