Skip to content

Commit 3633a56

Browse files
docs: Update README and package scope (#6)
* fix: Update package name to include scope for better organization Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com> * docs: Update README for OpenFeature branding and theme installation instructions Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com> * Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com> * docs: Fix formatting for theme installation instructions in README Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com> --------- Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent df6b8f4 commit 3633a56

File tree

2 files changed

+21
-23
lines changed

2 files changed

+21
-23
lines changed

README.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,35 @@
1-
# slidev-theme-open-feature
1+
# OpenFeature Slidev Theme
22

3-
[![NPM version](https://img.shields.io/npm/v/slidev-theme-open-feature?color=3AB9D4&label=)](https://www.npmjs.com/package/slidev-theme-open-feature)
3+
[![NPM version](https://img.shields.io/npm/v/@openfeature/slidev-theme-open-feature?color=3AB9D4&label=)](https://www.npmjs.com/package/@openfeature/slidev-theme-open-feature)
44

5-
A (...) theme for [Slidev](https://github.com/slidevjs/slidev).
6-
7-
<!--
8-
Learn more about how to write a theme:
9-
https://sli.dev/guide/write-theme.html
10-
--->
11-
12-
<!--
13-
run `npm run dev` to check out the slides for more details of how to start writing a theme
14-
-->
15-
16-
<!--
17-
Put some screenshots here to demonstrate your theme
18-
19-
Live demo: [...]
20-
-->
5+
An [OpenFeature](https://openfeature.dev)-branded theme for [Slidev](https://github.com/slidevjs/slidev). It features the official OpenFeature color palette, wave-style background decorations, and Poppins / Architects Daughter typography — with full support for light and dark mode.
216

227
## Install
238

249
Add the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically.
2510

26-
<pre><code>---
27-
theme: <b>open-feature</b>
28-
---</code></pre>
11+
```md
12+
---
13+
theme: '@openfeature/slidev-theme-open-feature'
14+
---
15+
```
2916

3017
Learn more about [how to use a theme](https://sli.dev/guide/theme-addon#use-theme).
3118

3219
## Layouts
3320

3421
This theme provides the following layouts:
3522

36-
> TODO:
23+
| Layout | Description |
24+
|--------|-------------|
25+
| `cover` | Title slide with centered content and prominent wave background |
26+
| `default` | Standard content slide with a title bar and body area |
27+
| `end` | Closing slide with centered content and prominent wave background |
28+
| `image-left` | Two-column layout with an image on the left (e.g., `image: path/to/image.jpg`) |
29+
| `image-right` | Two-column layout with an image on the right (e.g., `image: path/to/image.jpg`) |
30+
| `intro` | Introduction / about slide with centered content |
31+
| `section` | Section divider with large centered heading |
32+
| `two-cols` | Two-column layout using default and `::right::` slots |
3733

3834
## Components
3935

@@ -48,3 +44,5 @@ This theme provides the following components:
4844
- Edit the `example.md` and style to see the changes
4945
- `npm run export` to generate the preview PDF
5046
- `npm run screenshot` to generate the preview PNG
47+
48+
> **Note:** Node.js >= 18 is required. The repo includes an `.nvmrc` (Node 22) — run `nvm use` to pick it up.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "slidev-theme-open-feature",
2+
"name": "@openfeature/slidev-theme-open-feature",
33
"version": "0.0.0",
44
"type": "module",
55
"keywords": [

0 commit comments

Comments
 (0)