https://github.com/kaakaa/slidev-resources

Slidev resources and deployments
https://github.com/kaakaa/slidev-resources

slidev

Last synced: 23 days ago
JSON representation

Slidev resources and deployments

• Host: GitHub
• URL: https://github.com/kaakaa/slidev-resources
• Owner: kaakaa
• License: mit
• Created: 2023-05-20T05:03:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-19T14:25:09.000Z (8 months ago)
• Last Synced: 2024-05-20T04:22:40.000Z (8 months ago)
• Topics: slidev
• Language: TypeScript
• Homepage: https://kaakaa.github.io/slidev-resources/
• Size: 94.5 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Release slidev](https://github.com/kaakaa/slidev-resources/actions/workflows/release.yaml/badge.svg)](https://github.com/kaakaa/slidev-resources/actions/workflows/release.yaml)

# slidev-resources

This repository manage my [slidev](https://sli.dev/) resources.

* [GitHub Pages(SPA)](https://kaakaa.github.io/slidev-resources)

* [GitHub Releases(PDF)](https://github.com/kaakaa/slidev-resources/releases)

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/kaakaa/slidev-resources)

## Write and deploy a slide

1. Run `npm install`

2. Run `npm run new` and specify a name of directory (e.g.:`my-slide`) to create new sub-project

   * `npm run new` command will create `my-slide/slides.md` and `my-slide/public/`

   * `my-slide/slides.md` is an entry point for slidev. (Filename `slides.md` must not be changed because its name is hardcoded in some scripts in `package.json`)

   * Static files in `my-slide/public` can be refered from slide

     * e.g.: `my-slide/public/image.png` can be refered as `/image.png` from `my-slide/slides.md`

3. Commit subdirectory (e.g.: `my-slide/`) and create a tag with the name of the directory (e.g.: `my-slide`)

### Set up environment to write a slide

This repository has devcontainer setting, so you can create Codespace from [Your Codespaces](https://github.com/kaakaa/slidev-resources/codespaces) and write slidev on it.

There are two kinds of devcontainer.

| Configuration   | Description |

|:----------------|:------------|

| [Slidev Dev](./.devcontainer/devcontainer.json)  | Use `mcr.microsoft.com/vscode/devcontainers/universal:2-linux` |

| [Slidev Dev (ja)](./.devcontainer/slidev-dev-ja) | `Slidev Dev` + cjk font (fonts-noto-cjk) |

### Enable OGP on GitHub Pages (Experimental)

Adding `githubPages.ogp=true` to frontmatter enables OGP on GitHub Pages.

```yaml

...

githubPages:

  ogp: true

...

```

Parameters of OGP are from a front-matter in slidev entry file.

| ogp property   | front-matter | default value |

|:---------------|:-------------|:--------------|

| og:title       | title        | `Slidev Presentation` |

| og:type        | -            | `website`     |

| og:url         | -            | `${url_ghpages}`      |

| og:image       | -            | `${url_ghpages}/preview.png` |

| og:description | info         | `(empty)`     |

Preview image of `og:image` is generate from the first page of PDF file.

## When encounting font issue

If your slide encounters font issue, you need to add a step to install your language's font to [the release action](./.github/workflows/release.yaml).

For example (to install Japanese font):

```yaml

...

jobs:

  release:

    permissions:

      contents: write

    runs-on: ubuntu-latest

    steps:

      - name: Install Japanese font            # Insert these 2 lines

        run: sudo apt install -y fonts-noto    #     to install Japanese font

      - uses: actions/checkout@v3

      ...

```

# License

This repository is licensed under the MIT License. See [LICENSE](LICENSE) for the full license text.