mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
chore(markdown): try out alerts
This commit is contained in:
@@ -2,8 +2,6 @@
|
|||||||
|
|
||||||
ReadMe's Markdown engine.
|
ReadMe's Markdown engine.
|
||||||
|
|
||||||
## Table of contents <!-- omit in toc -->
|
|
||||||
|
|
||||||
1. [Syntax highlighting](#syntax-highlighting)
|
1. [Syntax highlighting](#syntax-highlighting)
|
||||||
1. [TODO lists](#todo-lists)
|
1. [TODO lists](#todo-lists)
|
||||||
1. [Folded content](#folded-content)
|
1. [Folded content](#folded-content)
|
||||||
@@ -16,11 +14,12 @@ ReadMe's Markdown engine.
|
|||||||
1. [Gantt diagram](#gantt-diagram)
|
1. [Gantt diagram](#gantt-diagram)
|
||||||
1. [Pie chart](#pie-chart)
|
1. [Pie chart](#pie-chart)
|
||||||
1. [Math](#math)
|
1. [Math](#math)
|
||||||
|
1. [Alerts](#alerts)
|
||||||
1. [Troubleshooting](#troubleshooting)
|
1. [Troubleshooting](#troubleshooting)
|
||||||
1. [Escape the backtick character](#escape-the-backtick-character)
|
1. [Escape the backtick character](#escape-the-backtick-character)
|
||||||
1. [VS Code and mermaid graph in Markdown preview](#vs-code-and-mermaid-graph-in-markdown-preview)
|
1. [VS Code and mermaid graph in Markdown preview](#vs-code-and-mermaid-graph-in-markdown-preview)
|
||||||
1. [Further readings](#further-readings)
|
1. [Further readings](#further-readings)
|
||||||
1. [Sources](#sources)
|
1. [Sources](#sources)
|
||||||
|
|
||||||
## Syntax highlighting
|
## Syntax highlighting
|
||||||
|
|
||||||
@@ -271,6 +270,54 @@ $$\sum_{n=1}^{10} n^2$$
|
|||||||
$\sum_{n=1}^{10} n^2$
|
$\sum_{n=1}^{10} n^2$
|
||||||
$$\sum_{n=1}^{10} n^2$$
|
$$\sum_{n=1}^{10} n^2$$
|
||||||
|
|
||||||
|
## Alerts
|
||||||
|
|
||||||
|
Uses the Alert extension.
|
||||||
|
|
||||||
|
Refer [Github's alert formatting][github formatting alerts].
|
||||||
|
|
||||||
|
```md
|
||||||
|
> [!NOTE]
|
||||||
|
> Useful information that users should know, even when skimming content.
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> Helpful advice for doing things better or more easily.
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> Key information users need to know to achieve their goal.
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Urgent info that needs immediate user attention to avoid problems.
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> Advises about risks or negative outcomes of certain actions.
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> Useful information that users should know, even when skimming content.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> Helpful advice for doing things better or more easily.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> Key information users need to know to achieve their goal.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Urgent info that needs immediate user attention to avoid problems.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> Advises about risks or negative outcomes of certain actions.
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### Escape the backtick character
|
### Escape the backtick character
|
||||||
@@ -291,11 +338,12 @@ Install and enable [`bierner.markdown-mermaid`][bierner.markdown-mermaid]'s exte
|
|||||||
- Official [documentation]
|
- Official [documentation]
|
||||||
- [Extended syntax]
|
- [Extended syntax]
|
||||||
- [Linguist supported language syntax list]
|
- [Linguist supported language syntax list]
|
||||||
|
- [Github's alert formatting][github formatting alerts]
|
||||||
|
|
||||||
## Sources
|
### Sources
|
||||||
|
|
||||||
All the references in the [further readings] section, plus the following:
|
|
||||||
|
|
||||||
|
- [Basic syntax]
|
||||||
|
- [Code blocks]
|
||||||
- [Escaping backticks]
|
- [Escaping backticks]
|
||||||
- [Escaping backtick in Markdown]
|
- [Escaping backtick in Markdown]
|
||||||
- [The magical Markdown I bet you don't know]
|
- [The magical Markdown I bet you don't know]
|
||||||
@@ -303,21 +351,19 @@ All the references in the [further readings] section, plus the following:
|
|||||||
- [Syntax highlighting in Markdown]
|
- [Syntax highlighting in Markdown]
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
References
|
Reference
|
||||||
|
═╬═Time══
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
<!-- Knowledge base -->
|
||||||
|
[mermaid.js]: mermaid.js.md
|
||||||
|
|
||||||
<!-- Upstream -->
|
<!-- Upstream -->
|
||||||
[basic syntax]: https://www.markdownguide.org/basic-syntax
|
[basic syntax]: https://www.markdownguide.org/basic-syntax
|
||||||
[code blocks]: https://docs.readme.com/rdmd/docs/code-blocks
|
[code blocks]: https://docs.readme.com/rdmd/docs/code-blocks
|
||||||
[documentation]: https://docs.readme.com/rdmd/docs
|
[documentation]: https://docs.readme.com/rdmd/docs
|
||||||
[extended syntax]: https://www.markdownguide.org/extended-syntax/
|
[extended syntax]: https://www.markdownguide.org/extended-syntax/
|
||||||
|
|
||||||
<!-- In-article sections -->
|
|
||||||
[further readings]: #further-readings
|
|
||||||
|
|
||||||
<!-- Knowledge base -->
|
|
||||||
[mermaid.js]: mermaid.js.md
|
|
||||||
|
|
||||||
<!-- Others -->
|
<!-- Others -->
|
||||||
[bierner.markdown-mermaid]: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid
|
[bierner.markdown-mermaid]: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid
|
||||||
[escaping backtick in markdown]: https://www.growingwiththeweb.com/2015/06/escaping-backtick-in-markdown.html
|
[escaping backtick in markdown]: https://www.growingwiththeweb.com/2015/06/escaping-backtick-in-markdown.html
|
||||||
@@ -326,3 +372,4 @@ All the references in the [further readings] section, plus the following:
|
|||||||
[slaise/high-level-markdown]: https://github.com/slaise/High-level-Markdown
|
[slaise/high-level-markdown]: https://github.com/slaise/High-level-Markdown
|
||||||
[syntax highlighting in markdown]: https://support.codebasehq.com/articles/tips-tricks/syntax-highlighting-in-markdown
|
[syntax highlighting in markdown]: https://support.codebasehq.com/articles/tips-tricks/syntax-highlighting-in-markdown
|
||||||
[the magical markdown i bet you don't know]: https://medium.com/codex/the-magical-markdown-i-bet-you-dont-know-b51f8c049773
|
[the magical markdown i bet you don't know]: https://medium.com/codex/the-magical-markdown-i-bet-you-dont-know-b51f8c049773
|
||||||
|
[github formatting alerts]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
|
||||||
|
|||||||
31
snippets/info-blocks.md
Normal file
31
snippets/info-blocks.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
<!-- markdownlint-disable-file MD041 -->
|
||||||
|
|
||||||
|
The idea here is to mimic Confluence's Info panel.
|
||||||
|
|
||||||
|
Use Markdown's [Alert extension](https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/).<br/>
|
||||||
|
See <https://github.com/sinsukehlab/NOTE-test/blob/main/NOTE.md> for more examples.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> Useful information that users should know, even when skimming content.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> Helpful advice for doing things better or more easily.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> Key information users need to know to achieve their goal.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Urgent info that needs immediate user attention to avoid problems.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> Advises about risks or negative outcomes of certain actions.
|
||||||
Reference in New Issue
Block a user