@korbiniankuhn/markdown-slides 0.0.1 → 0.0.2
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 +111 -0
- package/cli.js +0 -0
- package/package.json +5 -3
package/README.md
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# Markdown Slides
|
|
2
|
+
|
|
3
|
+
Create beautitful HDM-branded HTML slides from markdown.
|
|
4
|
+
|
|
5
|
+
Look at this beautiful example: [Here](test.html)
|
|
6
|
+
|
|
7
|
+
## How to use it
|
|
8
|
+
|
|
9
|
+
1. Create a repository for your slides
|
|
10
|
+
2. Add a .gitlab-ci.yml file
|
|
11
|
+
3. Create a README.md to start your slides
|
|
12
|
+
4. If you want to build your slides locally:
|
|
13
|
+
- NodeJS and npm are required
|
|
14
|
+
- npx @korbiniankuhn/markdown-slides
|
|
15
|
+
|
|
16
|
+
## Commandline arguments
|
|
17
|
+
|
|
18
|
+
Run `npx @korbiniankuhn/markdown-slides --help` to see all parameters.
|
|
19
|
+
|
|
20
|
+
| Identifier | Description | Description |
|
|
21
|
+
| ----------------- | ------------------------ | ------------------------------------------------------- |
|
|
22
|
+
| `-i, --input` | String (Default: .) | Input directory of the markdown files |
|
|
23
|
+
| `-o, --output` | String (Default: public) | Output directory of the html files |
|
|
24
|
+
| `--toc-numbering` | Boolean (Default: true) | Automatich numbering of headlines and table of contents |
|
|
25
|
+
|
|
26
|
+
## Features
|
|
27
|
+
|
|
28
|
+
- First slide will be styled differently to provide a pretty title slide
|
|
29
|
+
- Slide numbers will be generated automatically
|
|
30
|
+
- You get a fancy mobile menu as a table of contents and to jump to specific slides
|
|
31
|
+
- Every code snippet will be highlighted automatically with highlight.js (during build time)
|
|
32
|
+
- Use space and arrow keys to navigate
|
|
33
|
+
- Slides are fully response for mobile devices and small screens
|
|
34
|
+
- You can even choose the dark mode in the side-nav
|
|
35
|
+
- Slides have a modified CSS-Stylesheet for print to generate a PDF with the browser
|
|
36
|
+
- Supports multiple markdown files to split your presentation in subslides (README.md will always be the entrypoint)
|
|
37
|
+
- Date of the build will be included as a versioning on the first slide and the table of contents
|
|
38
|
+
- Links to other markdown files will be replace to .html during build. External links open in a new tab
|
|
39
|
+
- Presentation mode!
|
|
40
|
+
|
|
41
|
+
## Markdown extensions
|
|
42
|
+
|
|
43
|
+
### Slides
|
|
44
|
+
|
|
45
|
+
| Identifier | Description |
|
|
46
|
+
| ---------------- | ------------------ |
|
|
47
|
+
| `<!-- slide -->` | Starts a new slide |
|
|
48
|
+
|
|
49
|
+
### Blocks
|
|
50
|
+
|
|
51
|
+
Start blocks with `:::{marker}` and end block with `:::`
|
|
52
|
+
|
|
53
|
+
| Identifier | Description |
|
|
54
|
+
| ---------- | ----------------------------------------------- |
|
|
55
|
+
| `:::notes` | Start notes (only visible in presentation mode) |
|
|
56
|
+
|
|
57
|
+
#### Example
|
|
58
|
+
|
|
59
|
+
```markdown
|
|
60
|
+
:::notes
|
|
61
|
+
|
|
62
|
+
- Explain this
|
|
63
|
+
- Explain that
|
|
64
|
+
|
|
65
|
+
:::
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Layout
|
|
69
|
+
|
|
70
|
+
| Identifier | Description |
|
|
71
|
+
| ------------------ | ---------------------- |
|
|
72
|
+
| `<!-- row -->` | Starts a row container |
|
|
73
|
+
| `<!-- row:end -->` | Ends a row container |
|
|
74
|
+
| `<!-- col -->` | Starts a col container |
|
|
75
|
+
| `<!-- col:end -->` | Ends a col container |
|
|
76
|
+
|
|
77
|
+
#### Example
|
|
78
|
+
|
|
79
|
+
```markdown
|
|
80
|
+
<!-- row -->
|
|
81
|
+
<!-- col -->
|
|
82
|
+
|
|
83
|
+
Left
|
|
84
|
+
|
|
85
|
+
<!-- col:end -->
|
|
86
|
+
<!-- col -->
|
|
87
|
+
|
|
88
|
+
Right
|
|
89
|
+
|
|
90
|
+
<!-- col:end -->
|
|
91
|
+
<!-- row:end -->
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Spacer
|
|
95
|
+
|
|
96
|
+
| Identifier | Description |
|
|
97
|
+
| ------------------ | --------------------------- |
|
|
98
|
+
| `:spacer` | Medium vertical spacer |
|
|
99
|
+
| `:spacer{size=sm}` | Small vertical spacer |
|
|
100
|
+
| `:spacer{size=md}` | Medium vertical spacer |
|
|
101
|
+
| `:spacer{size=lg}` | Large vertical spacer |
|
|
102
|
+
| `:spacer{size=xl}` | Extra-Large vertical spacer |
|
|
103
|
+
|
|
104
|
+
### Images
|
|
105
|
+
|
|
106
|
+

|
|
107
|
+

|
|
108
|
+
|
|
109
|
+
### Custom CSS or JS
|
|
110
|
+
|
|
111
|
+
You can easily override the CSS or append custom JS logic. All files in the input directory with the extensions `.css` or `.js` are added to the HTML build.
|
package/cli.js
CHANGED
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@korbiniankuhn/markdown-slides",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "Create beautiful HDM branded HTML slides from markdown files",
|
|
5
5
|
"bin": {
|
|
6
|
-
"markdown-slides": "cli.js"
|
|
6
|
+
"@korbiniankuhn/markdown-slides": "node cli.js"
|
|
7
7
|
},
|
|
8
8
|
"author": "Korbinian Kuhn",
|
|
9
9
|
"license": "MIT",
|
|
10
|
-
"scripts": {
|
|
10
|
+
"scripts": {
|
|
11
|
+
"@korbiniankuhn/markdown-slides": "node cli.js"
|
|
12
|
+
},
|
|
11
13
|
"devDependencies": {},
|
|
12
14
|
"dependencies": {}
|
|
13
15
|
}
|