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.

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

Implementet Note blocks as <fieldset> #719

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Clicketyclick
Copy link

Creating field sets from blockquotes with header

Microsoft names this "Note blocks" but it is simply fieldsets
( https://docs.microsoft.com/en-us/contribute/how-to-write-use-markdown#note-blocks )

The Header has the syntax: [!#xxx]

Element Function
[! Legend start
# Special legend indicator
xxx Legend text
] Legend end

Examples:

This is a block quote

[!#NOTE]
This is a
NOTE block

will parse as

This is a block quote

ⓘ NOTEThis is a NOTE block

Special legends with Unicode indicator:

Function Unicode Tag Description
Note # (i)
Warning $ Jolly Roger / Skull and crossbones
Tip 💡 + Light bulb
Important ! /!\

Easy to spice up with som CSS

Creating field sets from blockquotes with header

Microsoft names this "Note blocks" but it is simply fieldsets
( https://docs.microsoft.com/en-us/contribute/how-to-write-use-markdown#note-blocks )

The Header has the syntax: [!#xxx]

Element | Function
--------|-------------------------
`[!`    | Legend start
`#`     | Special legend indicator
`xxx`   | Legend text
`]`     | Legend end


Examples:

> This is a block quote

> [!#NOTE]
> This is a 
> NOTE block

will parse as

<quote>This is a block quote</quote>
<fieldset class='legend1'><legend class='legend1'>&#9432; NOTE</legend>This is a NOTE block</fieldset>

Special legends with Unicode indicator:

Function    | Unicode   | Tag   | Description
------------|-----------|-------|------------
Note        | &#9432;   | #     | (i)
Warning     | &#x2620;  | $     | Jolly Roger / Skull and crossbones
Tip         | &#x1f4a1; | +     | Light bulb
Important   | &#9888;   | !     | /!\

Easy to spice up with som CSS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant