AxisCommunications / AxisCommunications/backstage-plugins

Readme Plugin: Allow the readme card render emojis in Backstage

Open
#235 1 comment 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
44
Forks
39
Avg merge
23h 40m
Merged PRs (30d)
59

Description

### Describe the feature

Since the readme card is a tool to provide information to users from the repository readme file, it would be nice that it couldrender emojis in the same way GitHub does.

### Added value

We would improve readability and be consistent with source experience.

### Additional context

Using packages:
@axis-backstage/plugin-readme@^0.9.0
@axis-backstage/plugin-readme-backend@^0.8.0
![readme-card-emoji](https://github.com/user-attachments/assets/63fa2ff7-a984-4351-a6f3-faaafe9aa0ef)

Contributor guide

Open the contributing guide

Research direction

Start by locating the readme card rendering entry point in @axis-backstage/plugin-readme and review its backend counterpart in @axis-backstage/plugin-readme-backend. Compare the current output with the linked emoji example and identify how the card handles README content; done means emojis render consistently with GitHub in the readme card.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
content, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.