Skip to content
This repository has been archived by the owner on Aug 22, 2022. It is now read-only.

Note block #15

Closed
bouncepaw opened this issue Dec 2, 2021 · 3 comments
Closed

Note block #15

bouncepaw opened this issue Dec 2, 2021 · 3 comments

Comments

@bouncepaw
Copy link
Owner

bouncepaw commented Dec 2, 2021 •
edited

I had this idea for a long time.

A note block is a little box with some text. It may be a reminder, a disclaimer, a warning, or whatever.

Many MediaWiki wikis have them implemented with templates and hacks. Well, it's considered idiomatic there.

Yandex Flavored Markdown, yet another dialect of Markdown (which has 4 levels of headings too, by the way), introduces such note blocks. Yandex's idea is similar to mine. That's great.

So, the syntax I purpose is as follows:

note <type> {
   <body>
}

Where:

  • <type> is an optional value. Possible values:

    • important for text that is so important everyone must read it.
    • tip for slightly related notes that may help readers.
    • warning for warnings. A good choice for marking sections deprecated.

    Default: tip.

  • <body> is a Mycomarkup-formatted text.

Each type has its own colors and icons. Every aspect of it is granularly configurable with CSS.
@bouncepaw
Copy link
Owner Author

Some questions

  • Do we allow all of Mycomarkup in body? The same question applies to table cells and image captions, by the way.
    • Maybe we should limit the subset of Mycomarkup in body.
  • Should the type set be like that? Maybe it should be larger?
  • Can custom types be introduced? It's all configured with CSS, why not?
    • I don't like the idea of custom types because having it ties Mycomarkup with HTML and CSS too much. Mycomarkup will have targets other than HTML, such as FB2 or PDF, for example.
    • And options are harmful.

@bouncepaw
Copy link
Owner Author

GitHub decided to get it too. They have a discussion going on. One can scroll it through. These are all examples of syntaces Mycomarkup is not going to have. I like GitHub's design of note blocks though, those colored icons are cute

Снимок экрана 2022-05-25 в 19 24 59

@bouncepaw
Copy link
Owner Author

Moved to https://todo.sr.ht/~bouncepaw/mycomarkup/2

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bouncepaw