support markdown alerts in documentation page
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 83
Description
### Describe the issue
Markdown has a feature called alerts that are supported [natively](https://github.com/orgs/community/discussions/16925) in GitHub and provide an excellent viewing experience in our GitHub documentation.
However, our documentation page does not support these magic alerts and [results](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html) in something ok, but not great (search for the raw `![Note]` or `![Important]`.
I think the simplest thing to do here is to just omit the line of `![Note]` if it shows up. It's no biggie either way :). I would love to continue using this feature in the GitHub docs and not have to worry about how it looks in our documentation site.
### Links
n/a
Contributor guide
Research direction
Start by locating the documentation-page rendering path that handles GitHub Markdown, then reproduce the AWS CDK documentation result using an alert such as `![Note]` or `![Important]`. Done means Markdown alerts no longer render as raw markers or otherwise degrade the documentation page, while ordinary documentation output remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100