@stonedeck/cli 0.7.5 → 0.7.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# @stonedeck/cli
|
|
2
|
+
|
|
3
|
+
> Create stunning presentations from Markdown
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @stonedeck/cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Use
|
|
12
|
+
|
|
13
|
+
### See your slides while editing
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
stonedeck preview my-slides.md --watch
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Opens a browser showing your presentation. Changes to your `.md` file update automatically!
|
|
20
|
+
|
|
21
|
+
### Export to HTML
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
stonedeck export my-slides.md
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Creates a `.html` file you can share or present anywhere.
|
|
28
|
+
|
|
29
|
+
### Get a PDF
|
|
30
|
+
|
|
31
|
+
Export to HTML first, then open it in your browser and use "Print to PDF".
|
|
32
|
+
|
|
33
|
+
## Create your first presentation
|
|
34
|
+
|
|
35
|
+
1. Make a file called `hello.md`:
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
---
|
|
39
|
+
StoneDeck: true
|
|
40
|
+
title: My First Deck
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
:::slide
|
|
44
|
+
---
|
|
45
|
+
layout: title
|
|
46
|
+
---
|
|
47
|
+
# Hello World
|
|
48
|
+
## Made with StoneDeck
|
|
49
|
+
:::
|
|
50
|
+
|
|
51
|
+
:::slide
|
|
52
|
+
---
|
|
53
|
+
layout: content
|
|
54
|
+
---
|
|
55
|
+
# Why StoneDeck?
|
|
56
|
+
|
|
57
|
+
- Write in Markdown
|
|
58
|
+
- Get beautiful slides
|
|
59
|
+
- No design skills needed
|
|
60
|
+
:::
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
2. Preview it:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
stonedeck preview hello.md --watch
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
3. Love it? Export it:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
stonedeck export hello.md
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
That's it! 🎉
|
|
76
|
+
|
|
77
|
+
## Commands
|
|
78
|
+
|
|
79
|
+
| Command | What it does |
|
|
80
|
+
|---------|--------------|
|
|
81
|
+
| `stonedeck preview <file>` | Opens slides in browser |
|
|
82
|
+
| `stonedeck preview <file> --watch` | Auto-reload on changes |
|
|
83
|
+
| `stonedeck export <file>` | Creates HTML file |
|
|
84
|
+
|
|
85
|
+
## Need more help?
|
|
86
|
+
|
|
87
|
+
Check the [full documentation](../../README.md)
|
|
88
|
+
|
|
89
|
+
## Repository
|
|
90
|
+
|
|
91
|
+
[https://github.com/matheuspellisoli/StoneDeck](https://github.com/matheuspellisoli/StoneDeck)
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
MIT
|