Skip to content

Commit f9a9869

Browse files
jhildenbiddlesy-records
authored andcommitted
Update docs and migrate to new syntax
1 parent f9950e0 commit f9a9869

15 files changed

+65
-50
lines changed

Diff for: docs/adding-pages.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ To create section headers:
6767

6868
You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
6969

70-
!> 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.
70+
> [!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.
7171
7272
Example file structure:
7373

@@ -98,7 +98,7 @@ You can specify `alias` to avoid unnecessary fallback.
9898
</script>
9999
```
100100

101-
!> You can create a `README.md` file in a subdirectory to use it as the landing page for the route.
101+
> [!IMPORTANT] You can create a `README.md` file in a subdirectory to use it as the landing page for the route.
102102
103103
## Set Page Titles from Sidebar Selection
104104

Diff for: docs/cdn.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Uncompressed resources are available by omitting the `.min` from the filename.
2929

3030
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.
3131

32-
?> When a new major version is released, you will need to manually update the major version number after the `@` symbol in your CDN URLs.
32+
> [!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.
3333
3434
<!-- prettier-ignore -->
3535
```html
@@ -44,7 +44,7 @@ Specifying the latest major version allows your site to receive all non-breaking
4444

4545
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.
4646

47-
?> When a new version is released, you will need to manually update the version number after the `@` symbol in your CDN URLs.
47+
> [!TIP] When a new version is released, you will need to manually update the version number after the `@` symbol in your CDN URLs.
4848
4949
<!-- prettier-ignore -->
5050
```html

Diff for: docs/configuration.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ Key `bindings` are defined as case insensitive string values separated by `+`. M
301301

302302
The `callback` function receive a [keydown event](https://developer.mozilla.org/en-US/docs/Web/API/Element/keydown_event) as an argument.
303303

304-
!> 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.
304+
> [!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.
305305
306306
```js
307307
window.$docsify = {
@@ -376,7 +376,7 @@ window.$docsify = {
376376

377377
Website logo as it appears in the sidebar. You can resize it using CSS.
378378

379-
!> Logo will only be visible if `name` prop is also set. See [name](#name) configuration.
379+
> [!IMPORTANT] Logo will only be visible if `name` prop is also set. See [name](#name) configuration.
380380
381381
```js
382382
window.$docsify = {
@@ -919,7 +919,7 @@ For more details, see [#1131](https://github.com/docsifyjs/docsify/issues/1131).
919919

920920
## themeColor ⚠️
921921

922-
!> Deprecated as of v5. Use the `--theme-color` [theme property](themes#theme-properties) to [customize](themes#customization) your theme color.
922+
> [!IMPORTANT] Deprecated as of v5. Use the `--theme-color` [theme property](themes#theme-properties) to [customize](themes#customization) your theme color.
923923
924924
- Type: `String`
925925

@@ -933,7 +933,7 @@ window.$docsify = {
933933

934934
## topMargin ⚠️
935935

936-
!> Deprecated as of v5. Use the `--scroll-padding-top` [theme property](themes#theme-properties) to specify a scroll margin when using a sticky navbar.
936+
> [!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.
937937
938938
- Type: `Number|String`
939939
- Default: `0`

Diff for: docs/custom-navbar.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
If you need custom navigation, you can create a HTML-based navigation bar.
66

7-
!> Note that documentation links begin with `#/`.
7+
> [!IMPORTANT] Note that documentation links begin with `#/`.
88
99
```html
1010
<!-- index.html -->
@@ -51,7 +51,7 @@ To create drop-down menus:
5151
- [chinese](/zh-cn/)
5252
```
5353

54-
!> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
54+
> [!IMPORTANT] You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
5555
5656
`_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`.
5757

Diff for: docs/deploy.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ It is recommended that you save your files to the `./docs` subfolder of the `mai
1414

1515
![GitHub Pages](_images/deploy-github-pages.png)
1616

17-
!> You can also save files in the root directory and select `main branch`.
18-
You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch)
17+
> [!IMPORTANT] You can also save files in the root directory and select `main branch`.
18+
> You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch)
1919
2020
## GitLab Pages
2121

2222
If you are deploying your master branch, create a `.gitlab-ci.yml` with the following script:
2323

24-
?> The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
24+
> [!TIP] The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
2525
2626
```YAML
2727
pages:
@@ -37,11 +37,11 @@ pages:
3737
- master
3838
```
3939
40-
!> You can replace script with `- cp -r docs/. public`, if `./docs` is your Docsify subfolder.
40+
> [!IMPORTANT] You can replace script with `- cp -r docs/. public`, if `./docs` is your Docsify subfolder.
4141

4242
## Firebase Hosting
4343

44-
!> 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.
44+
> [!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.
4545

4646
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.
4747

Diff for: docs/embed-files.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Example:
7575

7676
If you embed the file as `iframe`, `audio` and `video`, then you may need to set the attributes of these tags.
7777

78-
?> 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.
78+
> [!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.
7979
8080
```md
8181
[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
101101

102102
[](_media/example.html ':include :type=code text')
103103

104-
?> How to set highlight? You can see [here](language-highlight.md).
104+
> [!TIP] How to set highlight? You can see [here](language-highlight.md).
105105
106106
## Embed a gist
107107

108108
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.
109109

110-
?> **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.
110+
> [!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.
111111
112112
### Identify the gist's metadata
113113

@@ -132,7 +132,7 @@ Here are two examples based on the sample gist:
132132
- https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/content.md
133133
- https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/script.js
134134

135-
?> 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.
135+
> [!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.
136136
137137
Continue with one of the sections below to embed the gist on a Docsify page.
138138

Diff for: docs/helpers.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,16 @@ Docsify supports [GitHub style](https://docs.github.com/en/get-started/writing-o
5252

5353
The following Docsify v4 callout syntax has been deprecated and will be removed in a future version.
5454

55-
!> **Important** callouts communicate information necessary for users to succeed.
55+
!> Legacy **Important** callouts are deprecated.
5656

57-
?> **Tip** callouts communicate optional information to help a user be more successful.
57+
?> Legacy **Tip** callouts are deprecated.
5858

5959
**Markdown**
6060

6161
```markdown
62-
!> **Important** callouts communicate information necessary for users to succeed.
62+
!> Legacy **Important** callouts are deprecated.
6363

64-
?> **Tip** callouts communicate optional information to help a user be more successful.
64+
?> Legacy **Tip** callouts are deprecated.
6565
```
6666

6767
## Link attributes

Diff for: docs/index.html

+6
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@
4747
disabled
4848
/>
4949

50+
<!-- Prism Theme -->
51+
<!-- <link
52+
rel="stylesheet"
53+
href="//cdn.jsdelivr.net/npm/[email protected]/themes/prism-twilight.min.css"
54+
/> -->
55+
5056
<!-- Site styles -->
5157
<style>
5258
/* Plugin: Carbon Ads */

Diff for: docs/language-highlight.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ function add(a, b) {
5757

5858
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/):
5959

60-
!> Prism grammar files must be loaded after Docsify.
60+
> [!IMPORTANT] Prism grammar files must be loaded after Docsify.
6161
6262
```html
6363
<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
7979

8080
Docsify's official [themes](themes) are compatible with Prism syntax highlighting themes.
8181

82-
!> Prism themes must be loaded after Docsify themes.
82+
> [!IMPORTANT] Prism themes must be loaded after Docsify themes.
8383
8484
```html
8585
<!-- Light and dark mode -->

Diff for: docs/markdown.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ window.$docsify = {
1515
};
1616
```
1717

18-
?> Configuration Options Reference: [marked documentation](https://marked.js.org/#/USING_ADVANCED.md)
18+
> [!TIP] Configuration Options Reference: [marked documentation](https://marked.js.org/#/USING_ADVANCED.md)
1919
2020
You can completely customize the parsing rules.
2121

Diff for: docs/plugins.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Install the plugin and configure the track id.
123123

124124
Renders a larger collection of emoji shorthand codes. Without this plugin, Docsify is able to render only a limited number of emoji shorthand codes.
125125

126-
!> Deprecated as of v4.13. Docsify no longer requires this plugin for full emoji support.
126+
> [!IMPORTANT] Deprecated as of v4.13. Docsify no longer requires this plugin for full emoji support.
127127
128128
```html
129129
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/emoji.min.js"></script>

Diff for: docs/quickstart.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Run the local server with `docsify serve`. You can preview your site in your bro
3232
docsify serve docs
3333
```
3434

35-
?> For more use cases of `docsify-cli`, head over to the [docsify-cli documentation](https://github.com/docsifyjs/docsify-cli).
35+
> [!TIP] For more use cases of `docsify-cli`, head over to the [docsify-cli documentation](https://github.com/docsifyjs/docsify-cli).
3636
3737
## Manual initialization
3838

@@ -76,7 +76,7 @@ Download or create an `index.html` template using the following markup:
7676

7777
### Specifying docsify versions
7878

79-
?> Note that in both of the examples below, docsify URLs will need to be manually updated when a new major version of docsify is released (e.g. `v5.x.x` => `v6.x.x`). Check the docsify website periodically to see if a new major version has been released.
79+
> [!TIP] Note that in both of the examples below, docsify URLs will need to be manually updated when a new major version of docsify is released (e.g. `v5.x.x` => `v6.x.x`). Check the docsify website periodically to see if a new major version has been released.
8080
8181
Specifying a major version in the URL (`@5`) will allow your site to receive non-breaking enhancements (i.e. "minor" updates) and bug fixes (i.e. "patch" updates) automatically. This is the recommended way to load docsify resources.
8282

Diff for: docs/themes.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The Docsify "core" theme contains all of the styles and [theme properties](#them
1414

1515
Theme add-ons are used in combination with the [core theme](#core-theme). Add-ons contain CSS rules that modify [theme properties](#theme-properties) values and/or add custom style declarations. They can often (but not always) be used with other add-ons.
1616

17-
!> Theme add-ons must be loaded after the [core theme](#core-theme).
17+
> [!IMPORTANT] Theme add-ons must be loaded after the [core theme](#core-theme).
1818
1919
<!-- prettier-ignore -->
2020
```html
@@ -288,7 +288,7 @@ Docsify provides [theme properties](#theme-properties) for simplified customizat
288288
}
289289
```
290290

291-
?> **Theme authors**: Consider providing instructions for loading your recommended web fonts manually instead of including them in your theme using `@import`. This allows users who prefer a different font to avoid loading your recommended web font(s) unnecessarily.
291+
> [!TIP] **Theme authors**: Consider providing instructions for loading your recommended web fonts manually instead of including them in your theme using `@import`. This allows users who prefer a different font to avoid loading your recommended web font(s) unnecessarily.
292292
293293
4. Advanced styling may require custom CSS declarations. This is expected, however custom CSS declarations may break when new versions of Docsify are released. When possible, leverage [theme properties](#theme-properties) instead of custom declarations or lock your [CDN](cdn) URLs to a [specific version](cdn#specific-version) to avoid potential issues when using custom CSS declarations.
294294

@@ -302,7 +302,7 @@ Docsify provides [theme properties](#theme-properties) for simplified customizat
302302

303303
The following properties are available in all official Docsify themes. Default values for the "Core" theme are shown.
304304

305-
?> **Theme and plugin authors**: We encourage you to leverage these custom theme properties and to offer similar customization options in your projects.
305+
> [!TIP] **Theme and plugin authors**: We encourage you to leverage these custom theme properties and to offer similar customization options in your projects.
306306
307307
### Common
308308

Diff for: docs/ui-kit.md

+26-17
Original file line numberDiff line numberDiff line change
@@ -53,45 +53,54 @@
5353

5454
## Callouts
5555

56-
### Github Style
57-
5856
<!-- prettier-ignore -->
5957
> [!CAUTION]
60-
> **Caution** callouts communicate negative potential consequences of an action.
58+
> **Caution** callout with `inline code`.
6159
6260
<!-- prettier-ignore -->
6361
> [!IMPORTANT]
64-
> **Important** callouts communicate information necessary for users to succeed.
62+
> **Important** callout with `inline code`.
6563
6664
<!-- prettier-ignore -->
6765
> [!NOTE]
68-
> **Note** callouts communicate information that users should take into account.
66+
> **Note** callout with `inline code`.
6967
7068
<!-- prettier-ignore -->
7169
> [!TIP]
72-
> **Tip** callouts communicate optional information to help a user be more successful.
70+
> **Tip** callout with `inline code`.
7371
7472
<!-- prettier-ignore -->
7573
> [!WARNING]
76-
> **Warning** callouts communicate potential risks user should be aware of.
74+
> **Warning** callout with `inline code`.
75+
76+
**Multi Line**
77+
78+
<!-- prettier-ignore -->
79+
> [!NOTE]
80+
> - List item 1
81+
> - List item 2
82+
>
83+
> Text
84+
>
85+
> ```html
86+
> <p>Hello, World!</p>
87+
> ```
7788
7889
**Nested**
7990
8091
<!-- prettier-ignore -->
81-
> [!CAUTION]
82-
> **Caution** callouts communicate negative potential consequences of an action.
83-
> > [!IMPORTANT]
84-
> > **Important** callouts communicate information necessary for users to succeed.
92+
> [!NOTE]
93+
> Level 1
94+
> > [!NOTE]
95+
> > Level 2
8596
> > > [!NOTE]
86-
> > > **Note** callouts communicate information that users should take into account.
97+
> > > Level 3
8798
88-
#### Legacy Docsify Style
99+
**Legacy Style**
89100
90-
!> **Important** callout with `inline code` and additional placeholder text used
91-
to force the content to wrap and span multiple lines.
101+
!> Legacy **Important** callout with `inline code`.
92102
93-
?> **Tip** callout with `inline code` and additional placeholder text used to
94-
force the content to wrap and span multiple lines.
103+
?> Legacy **Tip** with `inline code`.
95104
96105
## Code
97106

Diff for: docs/vue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ window.$docsify = {
311311

312312
Vue content can mounted using a `<script>` tag in your markdown pages.
313313

314-
!> Only the first `<script>` tag in a markdown file is executed. If you wish to mount multiple Vue instances using a script tag, all instances must be mounted within the first script tag in your markdown.
314+
> [!IMPORTANT] Only the first `<script>` tag in a markdown file is executed. If you wish to mount multiple Vue instances using a script tag, all instances must be mounted within the first script tag in your markdown.
315315
316316
```html
317317
<script>

0 commit comments

Comments
 (0)