AxisCommunications / AxisCommunications/backstage-plugins

Readme Plugin: Hide comments when rendering the README in Backstage

Open
#234 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

> **Please do not disclose security vulnerabilities as issues. See our [security policy](../../SECURITY.md) for responsible disclosures.**

### Describe the bug

When I add a comment to the read me file, they are not rendered by Github but they are shown in the Readme card on backstage.
Example:

``

### To reproduce

Steps to reproduce the behavior:

1. Set up your readme.md file to have markdown comments
2. Add the component pointing to your repository/read-me
3. Check the Readme card

### Screenshots

![readme-card](https://github.com/user-attachments/assets/dbeba447-98e1-44da-b4a4-d700b04eb59c)

### Environment

- Axis device model: [e.g. Q1615 Mk III]
- Axis device firmware version: [e.g. 10.5]
- Stack trace or logs: [e.g. Axis device system logs]
- OS and version: [e.g. macOS v12.2.1, Ubuntu 20.04 LTS, Windows build 21996.1]
- Version: [version of the application, SDK, runtime environment, package manager, interpreter, compiler, depending on what seems relevant]

### Additional context

Using packages:
@axis-backstage/plugin-readme@^0.9.0
@axis-backstage/plugin-readme-backend@^0.8.0

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.