Website Summary Files Commits Branches @commit @diff @stats
path: root / exampleSite / content / home / usage.md
diff options
context:
space:
mode:
1 files changed, 109 insertions, 0 deletions
-rw-r--r--exampleSite/content/home/usage.md109
diff --git a/exampleSite/content/home/usage.md b/exampleSite/content/home/usage.md
new file mode 100644
index 0000000..a9ebe9d
--- /dev/null
+++ b/exampleSite/content/home/usage.md
@@ -0,0 +1,109 @@
++++
+weight = 20
++++
+
+# Usage
+
+---
+
+## Prerequisite
+
+First, add this to your `config.toml`:
+
+```toml
+[outputFormats.Reveal]
+baseName = "index"
+mediaType = "text/html"
+isHTML = true
+```
+
+---
+
+### Presentation at site root
+
+Create `content/_index.md`:
+
+```markdown
++++
+outputs = ["Reveal"]
++++
+
+# Slide 1
+
+Hello world!
+```
+
+---
+
+### Add slides
+
+Separate them by `---` surrounded by blank lines:
+
+```
+# Slide 1
+
+Hello world!
+
+---
+
+# Slide 2
+
+Hello program!
+```
+
+---
+
+### Add slides with other files
+
+Add slides to `content/home/*.md`
+
+```markdown
++++
+weight = 10
++++
+
+# Slide 3
+
+---
+
+# Slide 4
+```
+
+<small>💡 Tip: Use `weight` to specify the order that files should be considered.</small>
+
+---
+
+### Presentation at '/{section}/'
+
+Add slides to `content/{section}/_index.md`:
+
+```markdown
++++
+outputs = ["Reveal"]
++++
+
+# Slide 1
+
+---
+
+# Slide 2
+```
+
+---
+
+Add slides from other files in `content/{section}/*.md`
+
+```markdown
++++
+weight = 10
++++
+
+# Slide 3
+
+---
+
+# Slide 4
+```
+
+<small>💡 Tip: Use `weight` to specify the order that files should be considered.</small>
+