Skip to content

Commit d81a358

Browse files
committed
fix: docs
1 parent faf159e commit d81a358

File tree

7 files changed

+31
-16
lines changed

7 files changed

+31
-16
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,15 @@ For a full example, you can check the [demo](./demo) folder, which is a draft fo
3737

3838
## TODO
3939

40-
- [ ] Foot notes
41-
- [ ] Configuration in header
42-
- [ ] Preload next slide
4340
- [ ] Shiki + TwoSlash?
4441
- [ ] VS Code extension
45-
- [ ] Presentor View
4642
- [ ] Timer
4743
- [ ] A few more themes
4844
- [ ] Dialog before recording
4945
- [ ] Docs
46+
- [x] Presentor Mode
47+
- [x] Foot notes
48+
- [x] Configuration in header
5049
- [x] Hide dev buttons on build
5150
- [x] Embedded editor
5251
- [x] Custom Monaco setup
@@ -62,6 +61,8 @@ For a full example, you can check the [demo](./demo) folder, which is a draft fo
6261
- [x] Dev Mode
6362
- [x] Build Mode
6463
- [x] Export PDF
64+
- [x] Export PNG
65+
- [x] Better CLI
6566
- [x] Configurable themes
6667

6768
## Sponsors

docs/.vitepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const slidebars = [
2626
},
2727
{
2828
text: 'Record Presentation',
29-
link: '/guide/record',
29+
link: '/guide/recording',
3030
},
3131
{
3232
text: 'Presenter Mode',

docs/custom/components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ This also works:
3232

3333
> TODO:
3434
35-
Check more in the [directory structure](/guide/dir-structure) section.
35+
Check more in the [directory structure](/custom/dir-structure) section.

docs/guide/export.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,20 @@ Exporting your slides into PDF by the following command
88
$ slidev export
99
```
1010

11-
After a few seconds, your slides will be ready at `./slides.pdf`.
11+
After a few seconds, your slides will be ready at `./slides-exports.pdf`.
12+
13+
## PNGs
14+
15+
Passing the `--format png` option, it will export PNG images for each slide.
16+
17+
```bash
18+
$ slidev export --format png
19+
```
1220

1321
## Single-Page Application (SPA)
1422

23+
> ⚗️ Experimental
24+
1525
Since Slidev is a web app, there is no reason you can't host it.
1626

1727
You can build the slides into a self hostable SPA by:
File renamed without changes.

docs/guide/syntax.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@ Refer to [supported frontmatter fields](/guide/frontmatter-fields) for more deta
6666

6767
### Code Snippet
6868

69-
A big reason I am making this is that I need to make code looks right in the slides. So just as you expected, you can use markdown favored code block to highlight your code.
69+
A big reason I am making this is that I need to make my code looks just right in the slides. So just as you expected, you can use Markdown favored code block to highlight your code.
7070

7171
~~~md
7272
```ts
7373
console.log('HelloWorld')
7474
`​``
7575
~~~
7676

77-
Whenever you want to do some modification in the presentation, simply add `{monaco}` after the language id, it will turn the block into a full-featured Monaco editor!
77+
Whenever you want to do some modification in the presentation, simply add `{monaco}` after the language id, it turns the block into a full-featured Monaco editor!
7878

7979
~~~md
8080
```ts{monaco}
@@ -118,7 +118,7 @@ All the configurations needed can also be defined in the Markdown file. For exam
118118

119119
```md
120120
---
121-
theme: '@slidev/theme-seriph'
121+
theme: seriph
122122
layout: cover
123123
background: 'https://source.unsplash.com/1600x900/?nature,water'
124124
---
@@ -128,4 +128,4 @@ background: 'https://source.unsplash.com/1600x900/?nature,water'
128128
This is the cover page.
129129
```
130130

131-
For more details about using a theme, refer to [this section](/guide/use-theme).
131+
For more details about using a theme, refer to [this section](/themes/).

docs/guide/why.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,21 @@
44

55
There are a lot of feature-rich, general-purpose, WYSIWYG slides makers like [Microsoft PowerPoint](https://www.microsoft.com/en-us/microsoft-365/powerpoint) and [Apple Keynote](https://www.apple.com/keynote/). They work pretty well on making nice slides with animations, charts, and many other things, while being very intuitive and easy to learn. So why bother making Slidev?
66

7-
Slidev is trying to provide the flexibility and interactivity for developers to make their presentation even more interesting, expressive, and attractive by using the tools and technologies they are already familiar with. Slidev separates the content and visual to make you focus on one thing at a time, while being able to share and use the themes with the community.
7+
Slidev is trying to provide the flexibility and interactivity for developers to make their presentation even more interesting, expressive, and attractive by using the tools and technologies they are already familiar with. Slidev separates the content and visuals. This allows you to focus on one thing at a time, while being able to reuse the themes from the community.
88

9-
While Slidev will never tend to replace those slides apps and being beginner friendly, here is a few notions and highlights of Slidev:
9+
While Slidev will never tend to replace those slides apps and being beginner-friendly, here is a few notions and highlights of Slidev:
1010

1111
## Slidev
1212

1313
### Text-based
1414

1515
Slidev uses an extended Markdown format to store and organize your slides in a single plain text file. This lets you focus on making the content. And since the content and styles are separated, this also made it possible to switch between different themes effortlessly.
1616

17+
Learn mode about the slides [Markdown Syntax](/guide/syntax).
18+
1719
### Themable
1820

19-
Themes for Slidev can be shared and installed using npm packages. And apply them with only one line of config. Check out the [theme gallery](/guide/theme-gallery) or [how to write a theme](/guide/write-a-theme).
21+
Themes for Slidev can be shared and installed using npm packages. And apply them with only one line of config. Check out the [theme gallery](/themes/gallery) or [how to write a theme](/themes/write-a-theme).
2022

2123
### Developer Friendly
2224

@@ -28,12 +30,14 @@ You can write custom components and use them directly inside your markdown file.
2830

2931
### Recording Support
3032

31-
Slidev provides built-in recording and camera view. You can share your presentation with your camera view inside, or record and save seperately for your screen and camera. All with one go, no addition tools needed.
33+
Slidev provides built-in recording and camera view. You can share your presentation with your camera view inside, or record and save seperately for your screen and camera. All with one go, no additional tools are needed.
34+
35+
Learn more about the [recording here](/guide/recording).
3236

3337
### Portable
3438

3539
Export your slides into PDF, PNGs, or even a hostable Single-page Application (SPA) with a single command, and share them anywhere.
3640

3741
### Hackable
3842

39-
Since Slidev is powered by web technologies, anything that can be done with web apps are also possible with Slidev. For example, WebGL, API requesting, Iframes or even live sharing, it's up to your imaginations!
43+
Since Slidev is powered by web technologies, anything that can be done with web apps are also possible with Slidev. For example, WebGL, API requesting, iframes, or even live sharing, it's up to your imaginations!

0 commit comments

Comments
 (0)