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

docs: update for new alerts #47

Merged
merged 5 commits into from
Dec 5, 2024

Conversation

Meng-Heng
Copy link
Collaborator

@Meng-Heng Meng-Heng commented Dec 3, 2024

This PR should be ready for review.

Follows #44

@Meng-Heng Meng-Heng changed the base branch from main to alerts/v0.12 December 3, 2024 09:14
@Meng-Heng Meng-Heng added the documentation Improvements or additions to documentation label Dec 3, 2024
@Meng-Heng Meng-Heng modified the milestones: 18.0, A18S16 Dec 3, 2024
> [!CAUTION]
> Keyboard layouts are distributed through an open catalog to all major desktop and mobile platforms.
> [!WARNING]
> This is the last GFMAlerts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On #46, what happens with this example?

> [!TIPS] 
> [!IMPORTANT] 

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The output is:
image

Markdown:
image


```

## Limitation

The Alerts can't recognize new lines, HTML tags, nor handle two lines or more.
The Alerts can't recognize the inline content and HTML tags. Please stick to the rules/syntax.

```md
> [!WARNING] DO NOT do this.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the "DO NOT do this" examples, maybe have examples of what happens with inline content and HTML tags.

(and a comment // this will ....)

@Meng-Heng Meng-Heng requested a review from darcywong00 December 4, 2024 06:17
@mcdurdin mcdurdin merged commit 0d9e2e6 into keymanapp:alerts/v0.12 Dec 5, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants