docs: update docs about info options

slidevjs · May 7, 2021 · 90b48a1 · 90b48a1
1 parent 1fe5952
commit 90b48a1
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 4 deletions.
diff --git a/docs/custom/index.md b/docs/custom/index.md
@@ -18,6 +18,11 @@ download: true
 highlighter: 'prism'
 # enable monaco editor, default to dev only
 monaco: 'dev'
+# infomation for your slides, can be a markdown string
+info: |
+  ## Slidev
+
+  My first [Slidev](http://sli.dev/) presentations!
 ---
 ```
 

diff --git a/docs/guide/syntax.md b/docs/guide/syntax.md
@@ -160,7 +160,7 @@ background: 'https://source.unsplash.com/1600x900/?nature,water'
 This is the cover page.
 ```
 
-For more details about using a theme, refer to the [themes usage section](/themes/use).
+Learn more about [frontmatter configurations](/custom/#frontmatter-configures).
 
 ## LaTeX
 

diff --git a/packages/create-theme/template/README.md b/packages/create-theme/template/README.md
@@ -20,7 +20,9 @@ Live demo: [...]
 
 Add the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically.
 
-<pre><code>---<br>theme: <b>{{name}}</b><br>---</code></pre>
+<pre><code>---
+theme: <b>{{name}}</b>
+---</code></pre>
 
 Learn more about [how to use a theme](https://sli.dev/themes/use).
 

diff --git a/packages/theme-default/README.md b/packages/theme-default/README.md
@@ -8,7 +8,9 @@ The default theme for [Slidev](https://github.com/slidevjs/slidev).
 
 Add the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically.
 
-<pre><code>---<br>theme: <b>default</b><br>---</code></pre>
+<pre><code>---
+theme: <b>default</b>
+---</code></pre>
 
 Learn more about [how to use a theme](https://sli.dev/themes/use).
 

diff --git a/packages/theme-seriph/README.md b/packages/theme-seriph/README.md
@@ -8,7 +8,9 @@ An offical theme for [Slidev](https://github.com/slidevjs/slidev) using serif fo
 
 Add the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically.
 
-<pre><code>---<br>theme: <b>seriph</b><br>---</code></pre>
+<pre><code>---
+theme: <b>seriph</b>
+---</code></pre>
 
 Learn more about [how to use a theme](https://sli.dev/themes/use).