Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arthurgousset/markdown
✨ markdown cheat sheet
https://github.com/arthurgousset/markdown
Last synced: 18 days ago
JSON representation
✨ markdown cheat sheet
- Host: GitHub
- URL: https://github.com/arthurgousset/markdown
- Owner: arthurgousset
- Created: 2024-01-25T22:18:37.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-01-31T19:47:17.000Z (10 months ago)
- Last Synced: 2024-10-14T01:12:55.174Z (about 1 month ago)
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown (Cheat Sheet)
> [!TIP]
> This is a cheat sheet for all things markdown (mostly notes-to-self). They are incomplete by default
### Style guides
Technical writing style guides:
- [Google](https://developers.google.com/style) style guide
- [Apple](https://support.apple.com/en-gb/guide/applestyleguide/welcome/web) style guide
- [Red Hat](https://redhat-documentation.github.io/supplementary-style-guide/)
supplementary style guide for product documentation
Non-technical style guides:
- [The Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html)
(subscription required).
- [The Associated Press Stylebook](https://www.apstylebook.com/) (subscription required).
### Github admonitions
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> Negative potential consequences of an action.
```
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> Negative potential consequences of an action.
```
Source:
[[Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta) #16925](https://github.com/orgs/community/discussions/16925)