Markdown flavo(u)rs

Markdown flavo(u)rs



I like Markdown, and I use it daily to take notes (in Obsidian). Markdown has a lot of pros but a few cons such as non-standard features, among which "callouts" (also called admonitions). They are used to highlight a section of a note.

Within Obsidian and GitHub, callouts use the following syntax

> [!tip] A tip
> This is a callout        

The result looks like this :

Different "types" of callouts exist, such as info, question, todo, example, success, warning, etc ... Each one is rendered with a different style, as illustrated here in Obsidian documentation.


If you use MkDocs-Material or Python-Markdown, the syntax is a bit different : three exclamation marks, and a text indented with 4 spaces

!!! tip
    This is a callout        

With MyST no indentation needed, but braces and a closing "tag"

:::{tip}
This is a callout
:::        

Almost the same with Docusaurus, without the braces

:::tip
This is a callout
:::        

Randall Munroe was right, once again, with his famous "Standards" :



要查看或添加评论,请登录

Eric Cabrol的更多文章

  • Links of the week #52

    Links of the week #52

    Vehicle dynamics Point Mass Simulation free to use by Applied Racing Dynamics . Your channel needs more videos guys !…

    2 条评论
  • Links of the week #51

    Links of the week #51

    Finite Element Analysis Balancing Accuracy, Speed, and Memory in Finite Element Analysis (Jan 2025) by Lonny Thompson .…

    2 条评论
  • Links of the week #50

    Links of the week #50

    Vehicle dynamics 20+ Years of Suspension Kinematics Calculation (Mar. 2025) by Kevin Hayward .

    8 条评论
  • Links of the week #49

    Links of the week #49

    Control theory Closed-Loop Control: An Overview of Feedback Controllers (Feb. 2025) : a new video by Brian Douglas !…

    2 条评论
  • Links of the week #48

    Links of the week #48

    AI Things we learned about LLMs in 2024 (Dec. 2024), by Simon Willison (creator of Datasette) Top AI Trends Shaping…

    1 条评论
  • Links of the week #47

    Links of the week #47

    Vehicle dynamics On the Development of Vehicle Dynamics Active Systems: The Handling Stability Ratio as a Strategic…

  • Links of the week #46

    Links of the week #46

    Robotics Robotics 2024 Market Highlights: The Good, Bad, and the Ugly (Dec. 2024) by Robert Little Genesis: A…

    3 条评论
  • Links of the week #45

    Links of the week #45

    Vehicle dynamics Mastering vehicle development from concept to performance with VI-CarRealTime (Nov. 2024), a webinar…

    2 条评论
  • Links of the week #44

    Links of the week #44

    Automotive Advanced Brakes Benchmarking for EVs (part 1) Self-driving cars Introducing Waymo's Research on an…

    1 条评论
  • Links of the week #43

    Links of the week #43

    F1 / simulation How to drive an F1 car efficiently (via Canopy Simulations ) Ever wondered how Lando Norris manages to…

社区洞察

其他会员也浏览了