Skip to content

Commit bce1f3b

Browse files
committed
Simplify build process
1 parent 28efa4f commit bce1f3b

File tree

3 files changed

+20
-134
lines changed

3 files changed

+20
-134
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
# slides
1+
## Content
2+
3+
### Introduction
4+
5+
- [Welcome to Jumpstart](topics/introduction/welcome.html)
6+
7+
### Templates
8+
9+
- [Default template](topics/templates/default.html)
10+
- [Gaia template](topics/templates/gaia.html)
11+
- [Uncover template](topics/templates/uncover.html)
212

313
## Getting started
414

@@ -14,12 +24,12 @@ Within the `src` folder, select or create a new folder for a topic (e.g. `git`,
1424

1525
## Build your slide deck in watch mode
1626

17-
It is recommended that you run `npm run build:watch` so you can build your slide deck in watch mode to ensure that your slides are always built before you commit them.
27+
It is recommended that you run `npm run start` so you can build your slide deck in watch mode to ensure that your slides are always built before you commit them.
1828

19-
## Update the index page
29+
## Update README
2030

21-
Create a link to your deck in `index.md` so that it's easily accessible from the main page. Be sure to follow the format `topics/{your-topic}/{your-title}.html` (e.g. `[React]("topics/react/react.html")`).
31+
This README serves as the entry point. Update the content with a link to your deck. Be sure to follow the format `topics/{your-topic}/{your-title}.html` (e.g. `[React]("topics/react/react.html")`).
2232

23-
## Preview your deck
33+
## Preview your slides
2434

25-
To view your deck locally, run `npm run start` - this will run the build and serve your slides on localhost:5000 then navigate to your slide deck.
35+
Install the Marp extension for VS Code then view your slide as a regular Markdown preview.

package-lock.json

Lines changed: 0 additions & 118 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,9 @@
44
"description": "Jumpstart slides",
55
"main": "index.js",
66
"scripts": {
7-
"start": "npm run build && npm run serve",
8-
"serve": "python -m SimpleHTTPServer 5000",
9-
"build": "npm run remove-dist-folder && npm run copy-md-files && marp topics/ && npm run remove-md-files",
10-
"build:watch": "watch 'npm run build' src/",
11-
"remove-dist-folder": "rm -rf topics",
12-
"copy-md-files": "cp -r src/ topics/",
13-
"remove-md-files": "rm -r topics/**/*.md"
7+
"start": "npm run build:watch",
8+
"build": "marp --input-dir src --output topics",
9+
"build:watch": "watch 'npm run build' src/"
1410
},
1511
"repository": {
1612
"type": "git",
@@ -27,7 +23,5 @@
2723
"@marp-team/marp-cli": "^0.19.0",
2824
"watch": "^1.0.2"
2925
},
30-
"devDependencies": {
31-
"husky": "^4.2.5"
32-
}
26+
"devDependencies": {}
3327
}

0 commit comments

Comments
 (0)