diplodoc-platform / diplodoc-platform/cli

Allow markdown in index.yml description field

Open
#285 1 comment 0 reactions 0 assignees View on GitHub
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 ![](https://mockbin.org/public/mock.png)?
```

![изображение](https://user-images.githubusercontent.com/9265326/216230092-3e0f2b22-fa45-4e61-a65c-831c83f0a2f3.png)

Possibly adding HTML to description is a workaround now?

Contributor guide

Open the contributing 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.