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.

Sign up for GitHub

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
Merged

docs: update for new alerts #47

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8e2acdd
docs: update for new alerts
Meng-Heng Dec 3, 2024
35b77b8
docs: clarify the limitation and compress the images
Meng-Heng Dec 4, 2024
99ac5c2
docs: point to image locations
Meng-Heng Dec 4, 2024
bf2394c
docs: more clarification
Meng-Heng Dec 4, 2024
d9e4c5b
docs: typos
Meng-Heng Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 17 additions & 18 deletions _common/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,45 +14,44 @@ Here are the syntaxes of the Alerts for Keyman websites. There are 5 types of GF

## Working with Alerts

For every Alert that is used, there should be a gap in between each Alert, then a blank comment. After that, the next Alerts can be used.
The Five Alerts (Note, Tips, Important, Caution, and Warning) are recognized inside the `[! ]`. This should be able to support multiple lines as long as it is continuing from the previous alerts. Please find the examples below.

* One Alert

```md
> [!NOTE] Keyman Facts.
> [!NOTE]
> Keyman Facts.

```

* More than one

```md
> [!TIPS] Keyboard layouts are defined with a clear and easy to understand keyboard grammar.
// Always leave a line break.
<!-- Must Include a blank comment between each Alerts -->
> [!IMPORTANT] Keyman originally created in 1993 to type Lao on Windows.

<!-- -->
> [!CAUTION] Keyboard layouts are distributed through an open catalog to all major desktop and mobile platforms.

<!-- Last comment -->
> [!WARNING] This is the last GFMAlerts.
> [!TIPS]
> Keyboard layouts are defined with a clear and easy to understand keyboard grammar.

> [!IMPORTANT]
> Keyman originally created in 1993 to type Lao on Windows.
> Support new lines.

> [!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 ....)

> Second line // this will cause a 500 Error

<!-- -->
> [!WARNING] DO NOT do this.
Second line // this will cause a 500 Error
Second line

<!-- -->
> [!WARNING] DO NOT do this.
Second line // this will cause a 500 Error
Second line

```
Loading