Slidev Integration
This repository now supports Slidev presentations as part of the Jekyll build process.
How it works
- Write markdown as usual
- Create links ending with
-slidev/dist/to reference a Slidev presentation - The build process detects these links and automatically generates Slidev presentations
Example
If you have a file introduction.md:
# Introduction to GiellaLT
## Chapter 1
Content here...
## Chapter 2
More content...
See the Slidev documentation for more details on how to write Markdown-based presentations.
And you create a link to introduction-slidev/dist/ in another file:
[View presentation](introduction-slidev/dist/)
The build process will automatically detect the link and generate a Slidev presentation from introduction.md that becomes available at introduction-slidev/dist/.
How it works
- Detect links: GitHub Actions scans all
.mdand.htmlfiles for links ending with-slidev/dist/ - Build presentations: For each link, the corresponding
.mdfile is converted to a Slidev presentation - Publish: Jekyll copies the presentations as static files to the published website
Important: Only links ending with -slidev/dist/ will trigger presentation generation.
Local testing
To test Slidev functionality locally:
# Install dependencies
npm install
# Test Slidev integration
./infra/test-slidev.sh
# Or build Jekyll with Slidev support
bundle exec jekyll build
Customizing presentations
Slidev presentations are generated with default theme and settings. You can customize these by editing the GitHub Actions workflow in .github/workflows/docsygen.yml.
Default settings:
- Theme: seriph
- Background: Default Slidev background
- Syntax highlighting: shiki
- Line numbers: off
Deployment
Slidev presentations are automatically built and deployed to GitHub Pages through .github/workflows/docsygen.yml when code is pushed to the main branch.
Structure
.
├── introduction.md # Original markdown
├── introduction-slidev/ # Generated Slidev directory
│ └── dist/ # Built presentation
│ ├── index.html # Main presentation
│ └── assets/ # CSS, JS, etc.
└── _site/introduction-slidev/ # In Jekyll _site after build
Troubleshooting
- Presentation not generated: Check that the link ends with
-slidev/dist/and that the corresponding.mdfile exists - Build errors: Verify that Node.js and Slidev are installed correctly
- Styling issues: Check Slidev theme settings in the GitHub Actions workflow