slidev-theme-neversink 0.0.0 → 0.0.1

package/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    permissions:
+      id-token: write
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          registry-url: https://registry.npmjs.org/
+      - run: npx changelogithub
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - run: npm i -g @antfu/ni
+      - run: nci
+      - run: nr ci:publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+          NPM_CONFIG_PROVENANCE: true

package/README.md

@@ -1,8 +1,10 @@
 # Slidev Theme Neversink
 
-An education/academia oriented [Slidev](https://sli.dev/) theme with some whimsical elements.
+An education/academia oriented Slidev theme with some whimsical elements.
 
+Example [slides](https://gureckis.github.io/slidev-theme-neversink/example/).
 Documentation [here](https://gureckis.github.io/slidev-theme-neversink/)
+Read about [Slidev](https://sli.dev/).
 
 ## Installation
 
@@ -22,91 +24,12 @@ theme: neversink
 
 ## Features
 
-## Todo list
+- [Color schemes](colors.md) - the color schemes available in Neversink
+- [Custom layouts](layouts.md) - the custom slide layouts available in Neversink
+- [Branding](branding.md) - how to customize the theme to your brand/logos
+- [Components](components.md) - the custom components such as sticky notes and admonitions
+- [Markdown features](markdown.md) - special addons to the Slidev markdown syntax
 
-### Code cleanup
+## Examples
 
-- [x] refactor some of the layout stuff into layoutHelper.ts
-  - [x] two-cols-header
-  - [x] two-cols-footer
-  - [x] top-title
-  - [x] top-title-two-cols
-  - [x] side-title
-  - [x] quote
-  - [x] intro
-  - [x] cover
-- [x] fix <code> bg colors on colored slides
-- [x] add variables to configure things
-- [x] make global-top be a feature of my talks not the theme
-- [x] add a configuration option to global-bottom/slide-bottom for the date or whatever field
-- [x] clean up css classes
-- [ ] dark mode support
-- [ ] publish as a theme
-  - [ ] automate workflow for publishing to npm
-- add docs
-  - [x] vitepress setup published to github pages
-  - [ ] slide types
-  - [ ] add docs on how to customize variables/fonts
-
-### Layouts
-
-- [x] add a 100% full slide slide
-- [x] color side bar left/right
-- [x] two column footer
-- [x] two column (configurable) header
-- [x] four cell grid
-- [x] Add a config way to drop some of the lab/nyu stuff
-- [x] add a way to drop the page numbers
-- [x] color bar top/bottom centering
-- [x] color title page
-- [x] one up with caption below
-- [x] two up with caption below
-- [x] three up across with content option above and below (e.g., three panels of data)
-- [x] top title
-- [x] top title two cols
-- [x] two cols no header
-- [x] credits layout
-- [x] default (with color)
-- [x] sort out the global-top/slide-top thing (waiting for new slidev release)
-- [x] new section (with color)
-- [x] full (with color)
-- [x] quote (better style)
-- [x] scrolling credits slide
-  - [x] create as a layout also
-  - [x] add links and icons
-  - [ ] auto adjust height
-  - [ ] looping is not working
-  - [ ] use a animation library instead of raw request frame
-  - [ ] if in export mode then don't start scrolled down
-  - [ ] add keyboard commands to pause speed up and step forward/backwards in scrolling
-  - [ ] center final page
-
-<img src="/screenshots/credits-light.gif" alt="credits slide example" width="600" class="screenshot mb-10 mt-10"/>
-
-<img src="/screenshots/credits-dark.gif" alt="full slide example" width="600" class="screenshot"/>
-
-### components
-
-- [x] markdown admonitions
-- [x] draggable, custom admonition
-  - [ ] adminition colors for dark/navy/etc...
-- [x] speech bubble
-  - [~x] corner tails (good enough)
-  - [x] text-align
-  - [x] animations
-- [x] post-it note
-  - [ ] prop to toggle if only visible in dev mode (waiting for new slidev release)
-
-### Future ideas
-
-- [ ] dynamic color themes
-- [ ] thought bubble/comic style
-- [ ] tooltip that appears on hover or with a click
-- [ ] spoilers with clicks
-- [ ] spring loaded word cloud
-- [ ] quiz live polls
-- [ ] map
-- [ ] make admonition class be what the markdown processes uses
-- [ ] animations/layouts
-  - [ ] kawaii waving hands
-  - [ ] kawaii raising hands
+- Example [slides](https://gureckis.github.io/slidev-theme-neversink/example/).

package/docs/.vitepress/theme/index.js

@@ -12,7 +12,7 @@ import StickyNote from '../../../components/StickyNote.vue'
 import QrcodeVue from 'qrcode.vue'
 import SpeechBubble from '../../../components/SpeechBubble.vue'
 
-import Backpack from '../../../components/vue3-kawaii/components/backpack/Backpack.vue'
+import BackPack from '../../../components/vue3-kawaii/components/backpack/BackPack.vue'
 import Browser from '../../../components/vue3-kawaii/components/browser/Browser.vue'
 import Cat from '../../../components/vue3-kawaii/components/cat/Cat.vue'
 import CreditCard from '../../../components/vue3-kawaii/components/creditCard/CreditCard.vue'
@@ -37,7 +37,7 @@ export default {
     app.component('StickyNote', StickyNote)
     app.component('QRCode', QrcodeVue)
     app.component('SpeechBubble', SpeechBubble)
-    app.component('BackPack', Backpack)
+    app.component('BackPack', BackPack)
     app.component('Browser', Browser)
     app.component('Cat', Cat)
     app.component('CreditCard', CreditCard)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slidev-theme-neversink",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "author": "gureckis",
   "type": "module",
   "keywords": [
@@ -49,6 +49,7 @@
     "screenshot:dev": "slidev screenshot.md",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
+    "docs:preview": "vitepress preview docs",
+    "ci:publish": "pnpm publish --access public --no-git-checks"
   }
 }