Add custom Markdown Containers for callouts #344
Conversation
Note: Using babel-style for plugins declarations as it seems to work better with multiple declarations for vuepress-plugin-container
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/strapijs/documentation/6ZoCogBC9MwicWUEc3eLFh9FhRrA |
pwizla
requested review from
derrickmehaffy and
lauriejim
and removed request for
derrickmehaffy
pwizla
added
source: repo
docs/.vuepress/config.js
Outdated
| defaultTitle: '🤓 ' | ||
| }], | ||
| ['vuepress-plugin-container', { | ||
| type: 'prerequisites', |
There was a problem hiding this comment.
Wonder if we should generalize the name 🤔 instead of using prerequisites since we use it elsewhere besides just prerequisites.
Though if plan to add a bunch (would be nice) we probably need to document them somewhere, not needed for now but just a thought
There was a problem hiding this comment.
That's a good point, thank you!
I've updated the PR to:
- keep this one (so we have the "PREREQUISITES" defaultTitle ready)
- and create a generic 'callout', with the same look but without the defaultTitle
This way, if we ever decide to change the CSS of prerequisites, it wouldn't impact other callouts :-)
Btw I've already started documenting them in Notion 🙂
There was a problem hiding this comment.
I've updated the PR description to include these changes :-)
Indeed, that's planned, the contributing guide is going to be updated this quarter 🙂 |
pwizla
changed the title
In our mind, they are 3 different levels: - important, the less strong - caution, medium importance ( = VuePress's default 'warning') - warning, the strongest ( = VuePress's default 'danger')
We decided that we'll go with a unique callout, "caution". The title can still be adjusted when necessary.
|
Closing in favor of #368 |
2 participants
What does it do?
This PR:
:::prerequisites,:::strapiand a:::genericcallout (see screenshots below for end result)