feat: GitHub style callouts (#2487)

Co-authored-by: Koy Zhuang <[email protected]>
Co-authored-by: Luffy <[email protected]>

Author: 3 people

build/emoji.js

@@ -75,7 +75,6 @@ function writeEmojiJS(emojiData) {
   const isExistingPage = fs.existsSync(filePaths.emojiJS);
   const emojiJS = isExistingPage && fs.readFileSync(filePaths.emojiJS, 'utf8');
   const newEmojiJS = [
-    '/* eslint-disable */\n',
     '// =============================================================================',
     '// DO NOT EDIT: This file is auto-generated by an /build/emoji.js',
     '// =============================================================================\n',

docs/adding-pages.md

@@ -67,7 +67,7 @@ To create section headers:
 
 You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
 
-!> Docsify only looks for `_sidebar.md` in the current folder, and uses that, otherwise it falls back to the one configured using `window.$docsify.loadSidebar` config.
+> [!IMPORTANT] Docsify only looks for `_sidebar.md` in the current folder, and uses that, otherwise it falls back to the one configured using `window.$docsify.loadSidebar` config.
 
 Example file structure:
 
@@ -98,7 +98,7 @@ You can specify `alias` to avoid unnecessary fallback.
 </script>
 ```
 
-!> You can create a `README.md` file in a subdirectory to use it as the landing page for the route.
+> [!IMPORTANT] You can create a `README.md` file in a subdirectory to use it as the landing page for the route.
 
 ## Set Page Titles from Sidebar Selection
 

docs/cdn.md

@@ -29,7 +29,7 @@ Uncompressed resources are available by omitting the `.min` from the filename.
 
 Specifying the latest major version allows your site to receive all non-breaking enhancements ("minor" updates) and bug fixes ("patch" updates) as they are released. This is good option for those who prefer a zero-maintenance way of keeping their site up to date with minimal risk as new versions are published.
 
-?> When a new major version is released, you will need to manually update the major version number after the `@` symbol in your CDN URLs.
+> [!TIP] When a new major version is released, you will need to manually update the major version number after the `@` symbol in your CDN URLs.
 
 <!-- prettier-ignore -->
 ```html
@@ -44,7 +44,7 @@ Specifying the latest major version allows your site to receive all non-breaking
 
 Specifying an exact version prevents any future updates from affecting your site. This is good option for those who prefer to manually update their resources as new versions are published.
 
-?> When a new version is released, you will need to manually update the version number after the `@` symbol in your CDN URLs.
+> [!TIP] When a new version is released, you will need to manually update the version number after the `@` symbol in your CDN URLs.
 
 <!-- prettier-ignore -->
 ```html

docs/configuration.md

@@ -303,7 +303,7 @@ Key `bindings` are defined as case insensitive string values separated by `+`. M
 
 The `callback` function receive a [keydown event](https://developer.mozilla.org/en-US/docs/Web/API/Element/keydown_event) as an argument.
 
-!> Let site visitors know your custom key bindings are available! If a binding is associated with a DOM element, consider inserting a `<kbd>` element as a visual cue (e.g., <kbd>alt</kbd> + <kbd>a</kbd>) or adding [title](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) and [aria-keyshortcuts](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-keyshortcuts) attributes for hover/focus hints.
+> [!IMPORTANT] Let site visitors know your custom key bindings are available! If a binding is associated with a DOM element, consider inserting a `<kbd>` element as a visual cue (e.g., <kbd>alt</kbd> + <kbd>a</kbd>) or adding [title](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) and [aria-keyshortcuts](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-keyshortcuts) attributes for hover/focus hints.
 
 ```js
 window.$docsify = {
@@ -378,7 +378,7 @@ window.$docsify = {
 
 Website logo as it appears in the sidebar. You can resize it using CSS.
 
-!> Logo will only be visible if `name` prop is also set. See [name](#name) configuration.
+> [!IMPORTANT] Logo will only be visible if `name` prop is also set. See [name](#name) configuration.
 
 ```js
 window.$docsify = {
@@ -921,7 +921,7 @@ For more details, see [#1131](https://github.com/docsifyjs/docsify/issues/1131).
 
 ## themeColor ⚠️ :id=themecolor
 
-!> Deprecated as of v5. Use the `--theme-color` [theme property](themes#theme-properties) to [customize](themes#customization) your theme color.
+> [!IMPORTANT] Deprecated as of v5. Use the `--theme-color` [theme property](themes#theme-properties) to [customize](themes#customization) your theme color.
 
 - Type: `String`
 
@@ -935,7 +935,7 @@ window.$docsify = {
 
 ## topMargin ⚠️ :id=topmargin
 
-!> Deprecated as of v5. Use the `--scroll-padding-top` [theme property](themes#theme-properties) to specify a scroll margin when using a sticky navbar.
+> [!IMPORTANT] Deprecated as of v5. Use the `--scroll-padding-top` [theme property](themes#theme-properties) to specify a scroll margin when using a sticky navbar.
 
 - Type: `Number|String`
 - Default: `0`

docs/custom-navbar.md

@@ -4,7 +4,7 @@
 
 If you need custom navigation, you can create a HTML-based navigation bar.
 
-!> Note that documentation links begin with `#/`.
+> [!IMPORTANT] Note that documentation links begin with `#/`.
 
 ```html
 <!-- index.html -->
@@ -51,7 +51,7 @@ To create drop-down menus:
   - [chinese](/zh-cn/)
 ```
 
-!> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
+> [!IMPORTANT] You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
 
 `_navbar.md` is loaded from each level directory. If the current directory doesn't have `_navbar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`, the `_navbar.md` will be loaded from `/guide/_navbar.md`.
 

docs/deploy.md

@@ -14,14 +14,14 @@ It is recommended that you save your files to the `./docs` subfolder of the `mai
 
 ![GitHub Pages](_images/deploy-github-pages.png)
 
-!> You can also save files in the root directory and select `main branch`.
-You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch)
+> [!IMPORTANT] You can also save files in the root directory and select `main branch`.
+> You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch)
 
 ## GitLab Pages
 
 If you are deploying your master branch, create a `.gitlab-ci.yml` with the following script:
 
-?> The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
+> [!TIP] The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
 
 ```YAML
 pages:
@@ -37,11 +37,11 @@ pages:
   - master
 ```
 
-!> You can replace script with `- cp -r docs/. public`, if `./docs` is your Docsify subfolder.
+> [!IMPORTANT] You can replace script with `- cp -r docs/. public`, if `./docs` is your Docsify subfolder.
 
 ## Firebase Hosting
 
-!> You'll need to install the Firebase CLI using `npm i -g firebase-tools` after signing into the [Firebase Console](https://console.firebase.google.com) using a Google Account.
+> [!IMPORTANT] You'll need to install the Firebase CLI using `npm i -g firebase-tools` after signing into the [Firebase Console](https://console.firebase.google.com) using a Google Account.
 
 Using a terminal, determine and navigate to the directory for your Firebase Project. This could be `~/Projects/Docs`, etc. From there, run `firebase init` and choose `Hosting` from the menu (use **space** to select, **arrow keys** to change options and **enter** to confirm). Follow the setup instructions.
 

docs/embed-files.md

@@ -75,7 +75,7 @@ Example:
 
 If you embed the file as `iframe`, `audio` and `video`, then you may need to set the attributes of these tags.
 
-?> Note, for the `audio` and `video` types, docsify adds the `controls` attribute by default. When you want add more attributes, the `controls` attribute need to be added manually if need be.
+> [!TIP] Note, for the `audio` and `video` types, docsify adds the `controls` attribute by default. When you want add more attributes, the `controls` attribute need to be added manually if need be.
 
 ```md
 [filename](_media/example.mp4 ':include :type=video controls width=100%')
@@ -101,13 +101,13 @@ Embedding any type of source code file, you can specify the highlighted language
 
 [](_media/example.html ':include :type=code text')
 
-?> How to set highlight? You can see [here](language-highlight.md).
+> [!TIP] How to set highlight? You can see [here](language-highlight.md).
 
 ## Embed a gist
 
 You can embed a gist as markdown content or as a code block - this is based on the approach at the start of [Embed Files](#embed-files) section, but uses a raw gist URL as the target.
 
-?> **No** plugin or app config change is needed here to make this work. In fact, the "Embed" `script` tag that is copied from a gist will _not_ load even if you make plugin or config changes to allow an external script.
+> [!TIP] **No** plugin or app config change is needed here to make this work. In fact, the "Embed" `script` tag that is copied from a gist will _not_ load even if you make plugin or config changes to allow an external script.
 
 ### Identify the gist's metadata
 
@@ -132,7 +132,7 @@ Here are two examples based on the sample gist:
 - https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/content.md
 - https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/script.js
 
-?> Alternatively, you can get a raw URL directly clicking the _Raw_ button on a gist file. But, if you use that approach, just be sure to **remove** the revision number between `raw/` and the filename so that the URL matches the pattern above instead. Otherwise your embedded gist will **not** show the latest content when the gist is updated.
+> [!TIP] Alternatively, you can get a raw URL directly clicking the _Raw_ button on a gist file. But, if you use that approach, just be sure to **remove** the revision number between `raw/` and the filename so that the URL matches the pattern above instead. Otherwise your embedded gist will **not** show the latest content when the gist is updated.
 
 Continue with one of the sections below to embed the gist on a Docsify page.
 

docs/helpers.md

@@ -6,72 +6,106 @@ docsify extends Markdown syntax to make your documents more readable.
 
 ## Callouts
 
-### Important content
+Docsify supports [GitHub style](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) callouts (also known as "admonitions" or "alerts").
 
-Important content like:
+<!-- prettier-ignore -->
+> [!CAUTION]
+> **Caution** callouts communicate negative potential consequences of an action.
 
-```markdown
-!> **Time** is money, my friend!
-```
+<!-- prettier-ignore -->
+> [!IMPORTANT]
+> **Important** callouts communicate information necessary for users to succeed.
 
-is rendered as:
+<!-- prettier-ignore -->
+> [!NOTE]
+> **Note** callouts communicate information that users should take into account.
 
-!> **Time** is money, my friend!
+<!-- prettier-ignore -->
+> [!TIP]
+> **Tip** callouts communicate optional information to help a user be more successful.
 
-### Tips
+<!-- prettier-ignore -->
+> [!WARNING]
+> **Warning** callouts communicate potential risks user should be aware of.
 
-General tips like:
+**Markdown**
 
+<!-- prettier-ignore -->
 ```markdown
-?> _TODO_ unit test
+> [!CAUTION]
+> **Caution** callouts communicate negative potential consequences of an action.
+
+> [!IMPORTANT]
+> **Important** callouts communicate information necessary for users to succeed.
+
+> [!NOTE]
+> **Note** callouts communicate information that users should take into account.
+
+> [!TIP]
+> **Tip** callouts communicate optional information to help a user be more successful.
+
+> [!WARNING]
+> **Warning** callouts communicate potential risks user should be aware of.
 ```
 
-are rendered as:
+### Legacy Style ⚠️
 
-?> _TODO_ unit test
+The following Docsify v4 callout syntax has been deprecated and will be removed in a future version.
+
+!> Legacy **Important** callouts are deprecated.
+
+?> Legacy **Tip** callouts are deprecated.
+
+**Markdown**
+
+```markdown
+!> Legacy **Important** callouts are deprecated.
+
+?> Legacy **Tip** callouts are deprecated.
+```
 
 ## Link attributes
 
 ### disabled
 
-```md
+```markdown
 [link](/demo ':disabled')
 ```
 
 ### href
 
 Sometimes we will use some other relative path for the link, and we have to tell docsify that we don't need to compile this link. For example:
 
-```md
+```markdown
 [link](/demo/)
 ```
 
 It will be compiled to `<a href="/#/demo/">link</a>` and will load `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
 
 Now you can do that
 
-```md
+```markdown
 [link](/demo/ ':ignore')
 ```
 
 You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set the title for the link.
 
-```md
+```markdown
 [link](/demo/ ':ignore title')
 
 <a href="/demo/" title="title">link</a>
 ```
 
 ### target
 
-```md
+```markdown
 [link](/demo ':target=_blank')
 [link](/demo2 ':target=_self')
 ```
 
 ## Task lists
 
-```md
+```markdown
 - [ ] foo
 - bar
 - [x] baz
@@ -91,7 +125,7 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set th
 
 ### Class names
 
-```md
+```markdown
 ![logo](https://docsify.js.org/_media/icon.svg ':class=someCssClass')
 
 <!-- Multiple class names -->
@@ -101,13 +135,13 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set th
 
 ### IDs
 
-```md
+```markdown
 ![logo](https://docsify.js.org/_media/icon.svg ':id=someCssId')
 ```
 
 ### Sizes
 
-```md
+```markdown
 ![logo](https://docsify.js.org/_media/icon.svg ':size=WIDTHxHEIGHT')
 ![logo](https://docsify.js.org/_media/icon.svg ':size=50x100')
 ![logo](https://docsify.js.org/_media/icon.svg ':size=100')
@@ -123,7 +157,7 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set th
 
 ## Heading IDs
 
-```md
+```markdown
 ### Hello, world! :id=hello-world
 ```
 

docs/index.html

@@ -47,6 +47,12 @@
       disabled
     />
 
+    <!-- Prism Theme -->
+    <!-- <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/[email protected]/themes/prism-twilight.min.css"
+    /> -->
+
     <!-- Site styles -->
     <style>
       /* Plugin: Carbon Ads */

docs/language-highlight.md

@@ -57,7 +57,7 @@ function add(a, b) {
 
 Support for additional [languages](https://prismjs.com/#supported-languages) is available by loading the Prism [grammar files](https://cdn.jsdelivr.net/npm/prismjs@1/components/):
 
-!> Prism grammar files must be loaded after Docsify.
+> [!IMPORTANT] Prism grammar files must be loaded after Docsify.
 
 ```html
 <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
@@ -79,7 +79,7 @@ Support for additional [languages](https://prismjs.com/#supported-languages) is
 
 Docsify's official [themes](themes) are compatible with Prism syntax highlighting themes.
 
-!> Prism themes must be loaded after Docsify themes.
+> [!IMPORTANT] Prism themes must be loaded after Docsify themes.
 
 ```html
 <!-- Light and dark mode -->