foundation / foundation/yeti

Documentation markdown being ignored when wrapped in html

Open
#15,528 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
29.8k
Forks
5.4k
Avg merge
25m
Merged PRs (30d)
1

Description

## Description

Markdown isn't being converted to html in for the documentation when it's being wrapped in a html tag. This can be seen in a foundation callout box on the float and flex grid pages under the "importing" header.

Image
Image

## Possible Solution

In the examples I've found, these can easily be changed to use `` tags for the bold and `` for the link. But this issue could be in other places going unnoticed so this fix might be the best solution.

## Checklist

- [x] I have read and follow the CONTRIBUTING.md document.
- [x] There are no other issues similar to this one.
- [x] The issue title and template are correctly filled.

Contributor guide

Open the contributing guide

Research direction

Start with the documentation pages for the float and flex grids, specifically the callout boxes under the "importing" header, and inspect how their Markdown is wrapped in HTML. Check whether replacing the affected Markdown formatting and links with HTML produces the intended rendered output, then look for similar cases elsewhere in the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.