Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support GitHub-style asides #117

Open
QuietMisdreavus opened this issue Apr 3, 2023 · 1 comment
Open

support GitHub-style asides #117

QuietMisdreavus opened this issue Apr 3, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@QuietMisdreavus
Copy link
Contributor

Radar: rdar://107569909

GitHub supports "Note" and "Warning" callouts with a syntax similar to Swift-Markdown:

> **Note**
> This is a note.

> **Warning**
> This is a warning.
Rendered output

Note
This is a note.

Warning
This is a warning.

Swift-Markdown (and by extension Swift-DocC) should be able to support these varieties of callouts as native asides. This may require work in Swift-DocC as well, depending on how and where asides are converted.

@QuietMisdreavus QuietMisdreavus added the enhancement New feature or request label Apr 3, 2023
@grynspan
Copy link

grynspan commented Aug 21, 2023

Per https://github.com/orgs/community/discussions/16925, looks like there are a couple of different syntaxen for this.

> [!WARNING]
> Alert! Alert!
> **Warning**
> Callooh! Callay!

They render identically:

Warning

Oh me! Oh my!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants