Skip to content

Commit

Permalink
docs: add docs conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed May 5, 2021
1 parent fd89371 commit c577a11
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/themes/write-a-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ A theme can contribute to the following points:
- Extend Windi CSS configurations
- Configure tools like Monaco and Prism

## Conventions

Themes are published to npm registry, and they should following the conventions below:

- Package name should starts with `slidev-theme-`, for example: `slidev-theme-awesome`
- Add `slidev-theme` and `slidev` in the `keywords` field of your `package.json`

## Setup

To set up the testing playground for your theme, you can create `example.md` with the following frontmatter, to tell Slidev you are not inheriting from any existing theme.
Expand Down

0 comments on commit c577a11

Please sign in to comment.