Effect-TS / docgen

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

Support examples enclosed in MD code block #82

Closed vecerek closed 3 weeks ago

vecerek commented 3 weeks ago

What is the problem this feature would solve?

Shiki does not highlight the example code unless it's enclosed in a markdown code block. Here's a screenshot of one such example:

Screenshot 2024-11-03 at 07 32 54

If I do enclose the example in a MD code block, the docgen can no longer parse it.

What is the feature you are proposing to solve the problem?

When docgen parses the examples, it should strip the potential markdown code block tags.

What alternatives have you considered?

None.