question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[docs] Add more types of callouts

See original GitHub issue

Motivation

The blockquote/callout element is supposed to serve as a way to provide additional information that can vary in terms of relevance in comparison to the page content flow. What communicates relevance is its styling and currently, there is only one possible option for it: yellow, to resonate with warning info. There are instances where the blockquote is used but not to deliver information you should be warned about but rather something interesting you could consider — here are a few examples:

Request

The documentation might be improved if we added two other types of callouts. That would increase the flexibility to vary the relevance of given information. Generally, I think these are the ones we should support:

  1. Info/Note (blue): interesting point to consider (could be green as well?!).
  2. Caution (yellow): make sure you’re aware of this before moving forward.
  3. Warning/Danger (red): proceed very carefully (or at times, you shouldn’t do this at all).

And this is a very fast iteration on their styling — a bit of further polish would be needed.

Screen Shot 2022-03-15 at 09 15 41

cc @mui/docs-infra @mui/core

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:5
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

2reactions
siriwatknpcommented, Mar 23, 2022

I lean toward custom markdown syntax (Docusaurus)!

1reaction
oliviertassinaricommented, Mar 16, 2022

A quick benchmark of how this is implemented by some products:

  1. Notion. They encode their “callout” with <aside>. For example:
Screenshot 2022-03-16 at 16 48 29
<aside>
🥷 Private
</aside>
  1. Docusaurus. They call this a “Admonitions”, and encode it with a custom markdown syntax https://docusaurus.io/docs/markdown-features/admonitions. For example:
Screenshot 2022-03-16 at 16 51 50
:::note

Some **content** with _markdown_ `syntax`. Check [this `api`](#).

:::
  1. Vuetify. They use an <alert> with some form of post-processing to replace it with a div once rendered.
Screenshot 2022-03-16 at 17 25 24
<alert type="warning">
  For information on how to use Vue CLI, visit the [official documentation](https://cli.vuejs.org/).
</alert>
Read more comments on GitHub >

github_iconTop Results From Across the Web

About callout assets - Google Ads Help
Campaign types: Callouts can be added to Search Network campaigns and Search Network campaigns that have opted into the Display Network.
Read more >
Insert callouts in Docs - 飞书
Insert and edit callouts in Docs to catch your readers' attention and make your documents more organized and delightful to read.​.
Read more >
Google Docs: Inserting Text Boxes and Shapes - GCF Global
Adding shapes​​ You can add a variety of shapes to your document, including arrows, callouts, squares, stars, and flowchart shapes. Shapes are customizable,...
Read more >
Here's How to Insert Word Art, Callouts & shapes in Google ...
You can also insert shapes, arrows, callouts and equations in Google Docs. For a callout, click the Shapes icon and choose callout. google...
Read more >
Effective Presentation Visuals using Google Sheets/Slides
You may be using Google's apps ( Docs, Sheets, and Slides) as part of ... the visual in this video: - more built-in...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found