Skip to content

Commit

Permalink
README.md: add note about slidev
Browse files Browse the repository at this point in the history
Signed-off-by: Piotr Król <[email protected]>
  • Loading branch information
pietrushnic committed Sep 13, 2024
1 parent cd00fac commit feb46e1
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,54 @@ $ tree -L 2
&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp; ║<br>
&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp; ║<br>
&nbsp;&ensp;&ensp;TBD&ensp;&ensp;&ensp;║<br>

## Usage

Historically we used [remarkjs](https://github.com/remarkjs/remark) with our
own [remark-remplates](https://github.com/3mdeb/remark-templates), but since
September 2024 we started switching to [slidev](https://sli.dev/).

## How to preview presentation

### slidev

* Install npm manager e.g. [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#install--update-script)
* Use lts version of npm:

```bash
nvm install --lts
nvm use --lts
```

* Host presentations:

```bash
npm run dev -- -p 8000 --remote --force
```

* Open content in browser on http://0.0.0.0:8000

### remarkjs

* Clone repository
* Initialize submodules

```bash
git submodule update --init --recursive --checkout
```

* Run local HTTP server e.g.

```bash
python -m http.server
```

* Open content in browser on http://0.0.0.0:8000

## Contribution

* Please feel free to create issues for improvement ideas and bugs, as well as
pull requests to fix any issues.
* If you intend to provide code improvements, please install all dependencies.
* Before pushing code for review, ensure that `pre-commit run --all-files` does
not return any issues.

0 comments on commit feb46e1

Please sign in to comment.