Skip to content

Commit 8ddd51c

Browse files
committed
docs(plugin-revealjs): improve docs
1 parent 932d722 commit 8ddd51c

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/plugins/markdown/revealjs/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,12 @@ You can enable the following themes in reveal.js via `themes` in plugin options:
110110

111111
For the appearance of each theme, see [Themes demo](themes.md).
112112

113+
::: important Assets Path
114+
115+
Since markdown contents between `@slidestart` and `@slideend` are handled by Reveal.js at browser, so you can only use absolute paths for assets in slides, which must be accessible directly in browser, relative paths or alias are not supported.
116+
117+
:::
118+
113119
## Slide Layout
114120

115121
By default, the plugin registers a layout named `SlidePage` for you to render "a slides page".

docs/zh/plugins/markdown/revealjs/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,12 @@ const add = (a, b) => {
110110

111111
各主题的外观,详见 [幻灯片主题](themes.md)
112112

113+
::: important 资源路径
114+
115+
由于 `@slidestart``@slideend` 之间的 Markdown 内容由 Reveal.js 在浏览器中处理,因此你只能在幻灯片中使用绝对路径的资源,这些资源必须可以直接在浏览器中访问,不支持相对路径或别名。
116+
117+
:::
118+
113119
## 幻灯片布局
114120

115121
默认情况下,插件会注册一个 `SlidePage` 布局来供你渲染“幻灯片页”。

0 commit comments

Comments
 (0)