slidev-theme-kotlin 0.0.6

package/.github/workflows/pages.yml

@@ -0,0 +1,54 @@
+name: Deploy pages
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+
+      - name: Setup @antfu/ni
+        run: npm i -g @antfu/ni
+
+      - name: Install dependencies
+        run: nci
+
+      - name: Build
+        run: nr build --base /${{github.event.repository.name}}/
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: build
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 22.x
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@nomisrev'
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
+
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,233 @@
+# Slidev Theme Kotlin
+
+A [Slidev](https://sli.dev) theme designed for Kotlin presentations, featuring the Kodee mascot with smooth animations and Kotlin-optimized syntax highlighting.
+
+## Overview
+
+This theme provides a professional presentation template tailored for Kotlin developers. It includes:
+
+- **Kodee Mascot Integration**: Animated Kodee character with multiple variants (greeting, wink, wave, jumping, sitting, drinking, heart, in-love, welcome, winter, tiny)
+- **Magic Move Animations**: Smooth transitions for Kodee between slides with configurable size and position
+- **Kotlin Syntax Highlighting**: Custom Shiki configuration optimized for Kotlin code
+- **Multiple Layouts**: Pre-built layouts including default, cover, and intro
+- **Kotlin Branding**: Official Kotlin logos for both light and dark modes
+- **JetBrains Fonts**: Uses Inter for sans-serif and JetBrains Mono for code
+
+## Requirements
+
+- **Node.js**: >= 18.0.0
+- **Package Manager**: npm (or pnpm with shamefully-hoist=true)
+
+## Installation
+
+Install the theme in your Slidev project:
+
+```bash
+npm install @nomisrev/slidev-theme-kotlin
+```
+
+## Usage
+
+### Basic Setup
+
+Add the theme to your slides' frontmatter:
+
+```yaml
+---
+theme: @nomisrev/slidev-theme-kotlin
+---
+
+# Your Presentation Title
+```
+
+### Using Kodee Mascot
+
+Add Kodee to any slide by including the `kodee` configuration in the slide's frontmatter:
+
+```yaml
+---
+kodee:
+  variant: greeting
+  size: large
+  position: featured
+---
+
+# Your Slide Content
+```
+
+#### Kodee Configuration Options
+
+- **variant**: Choose from available Kodee images
+  - `greeting` - Kodee waving hello
+  - `wink` - Kodee winking
+  - `wave` - Kodee waving
+  - `jumping` - Kodee jumping with joy
+  - `sitting` - Kodee sitting down
+  - `drinking` - Kodee with a drink
+  - `heart` - Kodee with a heart
+  - `in-love` - Kodee in love
+  - `welcome` - Kodee welcoming
+  - `winter` - Kodee in winter attire
+  - `tiny` - Tiny Kodee
+
+- **size**: Control Kodee's size
+  - `small` - 200x200px (default)
+  - `large` - 600x600px (500x500px for wave variant)
+  - `medium` - TODO: Not yet implemented
+
+- **position**: Control Kodee's placement
+  - `corner` - Bottom right corner (default)
+  - `featured` - Prominently displayed on slide
+  - `custom` - Use with `x` and `y` coordinates
+
+#### Custom Positioning
+
+For precise control, use custom positioning:
+
+```yaml
+---
+kodee:
+  variant: greeting
+  position: custom
+  x: 100
+  y: 200
+  scale: 1.2
+---
+```
+
+## Development
+
+### Available Scripts
+
+```bash
+# Start development server with example presentation
+npm run dev
+
+# Build the example presentation for production
+npm run build
+
+# Export presentation to PDF
+npm run export
+
+# Export presentation as PNG screenshots
+npm run screenshot
+```
+
+### Running the Example
+
+The repository includes `example.md` demonstrating all theme features:
+
+```bash
+npm run dev
+```
+
+This will open the example presentation in your browser with hot-reload enabled.
+
+## Project Structure
+
+```
+.
+├── components/          # Vue components
+│   ├── Kodee.vue       # Main Kodee mascot component with animations
+│   └── KodeeWrapper.vue # Wrapper component for Kodee integration
+├── layouts/            # Slidev layout templates
+│   ├── cover.vue       # Cover slide layout
+│   ├── default.vue     # Default slide layout
+│   └── intro.vue       # Introduction slide layout
+├── public/             # Static assets
+│   ├── kodee-*.svg     # Kodee mascot variants (11 variants)
+│   └── kotlin-logo*.svg # Kotlin logos (light/dark modes)
+├── setup/              # Slidev setup files
+│   └── shiki.ts        # Syntax highlighting configuration for Kotlin
+├── styles/             # Theme styles
+│   ├── index.ts        # Style entry point
+│   └── layout.css      # Layout styles
+├── debug.js            # Utility script for enumerating Shiki Kotlin tokens
+├── example.md          # Example presentation demonstrating theme features
+├── package.json        # Package configuration and dependencies
+└── LICENSE             # Apache License 2.0
+```
+
+## Environment Variables
+
+<!-- TODO: Document any environment variables if needed -->
+
+No environment variables are currently required for this theme.
+
+## Testing
+
+<!-- TODO: Add test setup and instructions -->
+
+No automated tests are currently configured for this theme.
+
+## Configuration
+
+### Theme Defaults
+
+The theme is configured with the following defaults in `package.json`:
+
+```json
+{
+  "slidev": {
+    "colorSchema": "both",
+    "defaults": {
+      "fonts": {
+        "sans": "Inter",
+        "mono": "JetBrains Mono"
+      }
+    }
+  }
+}
+```
+
+## Layouts
+
+The theme provides three layouts:
+
+1. **default** - Standard slide layout with optional Kodee
+2. **cover** - Cover slide for presentation title
+3. **intro** - Introduction slide layout
+
+Use layouts by specifying them in slide frontmatter:
+
+```yaml
+---
+layout: cover
+---
+
+# Presentation Title
+```
+
+## Dependencies
+
+### Runtime Dependencies
+- `@slidev/types` (^52.2.5) - Slidev type definitions
+
+### Development Dependencies
+- `@slidev/cli` (^52.2.5) - Slidev command-line interface
+
+## Contributing
+
+<!-- TODO: Add contribution guidelines -->
+
+Contributions are welcome! Please feel free to submit issues or pull requests.
+
+## License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
+
+## Credits
+
+- **Kodee Mascot**: Official Kotlin mascot by JetBrains
+- **Kotlin Logos**: Official Kotlin branding by JetBrains
+- **Slidev**: Presentation framework by [Anthony Fu](https://github.com/antfu)
+
+## Links
+
+- [Slidev Documentation](https://sli.dev)
+- [Kotlin Official Website](https://kotlinlang.org)
+- [Package on npm](https://www.npmjs.com/package/@nomisrev/slidev-theme-kotlin)
+
+---
+
+Made with ❤️ for the Kotlin community

package/components/Kodee.vue

@@ -0,0 +1,142 @@
+<script setup lang="ts">
+import {computed} from 'vue'
+
+interface Props {
+  variant?: string
+  size?: 'small' | 'large' | 'medium'
+  position?: 'corner' | 'featured' | 'custom'
+  x?: number
+  y?: number
+  scale?: number
+}
+
+const props = withDefaults(defineProps<Props>(), {
+  variant: 'greeting',
+  size: 'small',
+  position: 'corner',
+  x: undefined,
+  y: undefined,
+  scale: undefined,
+})
+
+// Compute image source
+const imageSrc = computed(() => {
+  const variant = props.variant.startsWith('kodee-') ? props.variant : `kodee-${props.variant}`
+  return `${variant}.svg`
+})
+const kodeeImage = computed(() => {
+  const base = import.meta.env.BASE_URL || '/'
+  return `${base}${imageSrc.value}`
+})
+
+// Compute size classes and dimensions
+const sizeConfig = computed(() => {
+  switch (props.size) {
+    case 'large':
+      if (imageSrc.value.endsWith("kodee-wave.svg")) {
+        return {width: '500px', height: '500px'}
+      } else {
+        return {width: '600px', height: '600px'}
+      }
+    case 'small':
+    default:
+      return {width: '200px', height: '200px'}
+  }
+})
+
+// Compute position styles
+const positionStyles = computed(() => {
+  const styles: Record<string, string> = {
+    position: 'absolute',
+    width: sizeConfig.value.width,
+    height: sizeConfig.value.height,
+  }
+
+  const src = imageSrc.value
+  console.log(`[DEBUG] Kodee image: encountered ${src}`)
+
+  styles.right = '0px'
+  if (props.position === 'corner') {
+    if (src.endsWith("kodee-greeting.svg")) {
+      styles.bottom = '-42px'
+    } else if (src.endsWith("kodee-wink.svg")) {
+      styles.bottom = '-35px'
+    } else if (src.endsWith("kodee-wave.svg")) {
+      styles.bottom = '-15px'
+    } else {
+      styles.bottom = '-42px'
+    }
+
+  } else if (props.position === 'featured') {
+    styles.right = '-5%'
+    styles.transform = 'translateY(-40%)'
+
+    if (src.endsWith("kodee-greeting.svg")) {
+      styles.top = '13%'
+    } else if (src.endsWith("kodee-wink.svg")) {
+      styles.top = '10%'
+    } else if (src.endsWith("kodee-wave.svg")) {
+      styles.top = '16%'
+      styles.right = '3%'
+    } else {
+      styles.top = '0%'
+    }
+
+  } else if (props.position === 'custom' && props.x !== undefined && props.y !== undefined) {
+    styles.left = `${props.x}px`
+    styles.top = `${props.y}px`
+  }
+
+  return styles
+})
+
+// Compute v-motion animation config
+const motionConfig = computed(() => {
+  const baseScale = props.scale || 1
+
+  return {
+    initial: {
+      opacity: 0,
+      scale: baseScale * 0.8,
+    },
+    enter: {
+      opacity: 1,
+      scale: baseScale,
+      transition: {
+        type: 'spring',
+        stiffness: 100,
+        damping: 15,
+        mass: 1,
+      },
+    },
+    leave: {
+      opacity: 0,
+      scale: baseScale * 0.8,
+      transition: {
+        duration: 300,
+      },
+    },
+  }
+})
+</script>
+
+<template>
+  <img
+      v-motion
+      :initial="motionConfig.initial"
+      :enter="motionConfig.enter"
+      :leave="motionConfig.leave"
+      :src="kodeeImage"
+      :alt="`Kodee ${variant}`"
+      :style="positionStyles"
+      class="kodee-character"
+  />
+</template>
+
+<style scoped>
+.kodee-character {
+  pointer-events: none;
+  object-fit: contain;
+  view-transition-name: kodee-mascot;
+}
+</style>

package/components/KodeeWrapper.vue

@@ -0,0 +1,29 @@
+<script setup lang="ts">
+import { computed } from 'vue'
+import { useSlideContext } from '@slidev/client'
+import Kodee from './Kodee.vue'
+
+const slideContext = useSlideContext()
+
+// Get kodee configuration from frontmatter
+const kodeeConfig = computed(() => {
+  return slideContext.$frontmatter?.kodee || null
+})
+
+// Check if kodee should be shown on this slide
+const showKodee = computed(() => {
+  return kodeeConfig.value !== null && kodeeConfig.value !== false
+})
+</script>
+
+<template>
+  <Kodee
+    v-if="showKodee"
+    :variant="kodeeConfig.variant"
+    :size="kodeeConfig.size"
+    :position="kodeeConfig.position"
+    :x="kodeeConfig.x"
+    :y="kodeeConfig.y"
+    :scale="kodeeConfig.scale"
+  />
+</template>