Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gabriel-del committed May 5, 2022
1 parent 29ea107 commit 1e27372
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 13 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ dist
index.html
.remote-assets
components.d.ts
*.lock
*.log
pdf
47 changes: 41 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,46 @@
# Welcome to [Slidev](https://github.com/slidevjs/slidev)!
# Template to [Slidev](https://github.com/slidevjs/slidev)!

To start the slide show:
Presentation Slides for Developers

- `npm install`
- `npm run dev`
[Demo](gabriel-del.github.io/slidev/slides/)

To start the slide show locally:

- `yarn dev <presentation>`
- visit http://localhost:3030

Edit the [slides.md](./slides.md) to see the changes.
With this options, it's possible to record a presentation and edit files on browser.

To generate the html files locally:

- `yarn build`


There is also the option to export the presentations to pdf files:

- `yarn export`


To reproduce the project, including the github-pages:

- Fork de project
- Allow permission: settings -> Actions (General) -> Workflow permissions (Read and write permissions)
- It'll be generated a gh-pages branch with the content. It can take more than 3min.

Edit the [./presentations/slides.md](./presentations/slides.md) to see the changes.

Learn more about on [Slidev guide](https://sli.dev/guide).


#### Improvements

Decrease `yarn build` time.









Learn more about Slidev on [documentations](https://sli.dev/).
3 changes: 0 additions & 3 deletions build.sh

This file was deleted.

9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
{
"private": true,
"scripts": {
"build": "./build.sh",
"dev": "slidev --open",
"export": "slidev export"
"build": "./slidev.sh build",
"dev": "./slidev.sh dev",
"export": "./slidev.sh export"
},
"dependencies": {
"@slidev/cli": "^0.30.3",
"@slidev/theme-default": "*",
"@slidev/theme-seriph": "*"
"@slidev/theme-seriph": "*",
"playwright-chromium": "^1.21.1"
},
"name": "slides"
}
40 changes: 40 additions & 0 deletions slidev.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#!/bin/bash

case "$1" in
build)
for i in $(ls presentations/*.md | sed 's/presentations\/\|\.md//g')
do slidev build ./presentations/$i.md -d --base /slidev/$i/ --out ../dist/$i/
done
;;
dev)
slidev --open ./presentations/$2.md
# "${@:2}"
;;
export)
mkdir -p pdf
for i in $(ls presentations/*.md | sed 's/presentations\/\|\.md//g')
do slidev export ./presentations/$i.md --output ./pdf/$i.pdf --timeout 1000000
done
;;
*)
;;
esac



















0 comments on commit 1e27372

Please sign in to comment.