diplodoc-platform / diplodoc-platform/cli
Allow markdown in index.yml description field
- Dominant language
- TypeScript
- Stars
- 123
- Forks
- 51
- Avg merge
- 10h 50m
- Merged PRs (30d)
- 38
Description
There is apparently a way to add links in index.yml description, but no success so far:
```
title: Page title
imgSrc:
description: |
[Can this be a link](https://mockbin.org/)
or an image ?
```

Possibly adding HTML to description is a workaround now?
Contributor guide
Research direction
Start by reproducing the example in index.yml and tracing how the CLI parses and renders its description field. Check whether existing documentation or tests cover description formatting. Done means links and images written with Markdown render correctly without breaking plain-text descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100