Skip to content

Commit

Permalink
docs: improve some formulations in the themes documentation (#3)
Browse files Browse the repository at this point in the history
* fix(docs): improve some formulations

* chore: changes

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>
  • Loading branch information
nico-bachner and antfu committed May 5, 2021
1 parent dc56f58 commit fd89371
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/themes/gallery.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Themes Gallery

Browser awesome themes available for Slidev here.
Browse awesome themes available for Slidev here.

Read more about [how to use a theme](/themes/use), or [write one your own](/themes/write-a-theme) and share with the community!
Read more about [how to use a theme](/themes/use), or [how to write your own](/themes/write-a-theme) and share with the community!

## Official Themes

Expand Down
4 changes: 2 additions & 2 deletions docs/themes/use.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ or you can install the theme manually via
$ npm install @slidev/theme-seriph
```

And let's all, enjoy the new theme! Refer to the theme's readme for more details about the usage.
And that's all, enjoy the new theme! For more details about the usage, you can refer to the theme's README.

Want to share your theme? Read more about [how to write a theme](/themes/write-a-theme).
Want to share your theme? Learn about [how to write a theme](/themes/write-a-theme).
14 changes: 7 additions & 7 deletions docs/themes/write-a-theme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Write a Theme

To get started, we recommend you use our generator to scaffolding your first theme
To get started, we recommend you use our generator for scaffolding your first theme

```bash
$ npm init slidev-theme
```

Then you can modify and play with it. Also, refer to the [official themes](/themes/gallery) as examples.
Then you can modify and play with it. You can also refer to the [official themes](/themes/gallery) as examples.

## Capability

Expand Down Expand Up @@ -43,13 +43,13 @@ Optionally, you can also add some scripts to your `packages.json`
}
```

To publish your theme, simply run `npm publish` and you are good to go. There is not build process required (which means you can directly publish `.vue` and `.ts` files, Slidev is smart enough to understand them).
To publish your theme, simply run `npm publish` and you are good to go. There is no build process required (which means you can directly publish `.vue` and `.ts` files, Slidev is smart enough to understand them).

Theme contribution points follow the same conventions as local customization, please refer to [the docs for the naming conventions](/custom/).

## Color Schema

By default, Slidev assumes themes are supporting both light mode and dark mode. If you only want your theme be presented in a designed color schema, you will need to specify it explicitly in `package.json`
By default, Slidev assumes themes support both light mode and dark mode. If you only want your theme be presented in a designed color schema, you will need to specify it explicitly in `package.json`

```json
// package.json
Expand All @@ -67,11 +67,11 @@ By default, Slidev assumes themes are supporting both light mode and dark mode.

## Highlighter

Syntax highlighting colors are also provided in the theme. We support both [Prism](https://prismjs.com/) and [Shiki](https://github.com/shikijs/shiki), [read more here](/custom/highlighters).
Syntax highlighting colors are also provided in the theme. We support both [Prism](https://prismjs.com/) and [Shiki](https://github.com/shikijs/shiki). For more information please refer to [the syntax highlighting docs](/custom/highlighters).

You can support one of them or both. Refer to the default theme for configurations examples [prism.css](https://github.com/slidevjs/slidev/blob/main/packages/theme-default/styles/prism.css) / [setup/shiki.ts](https://github.com/slidevjs/slidev/blob/main/packages/theme-default/setup/shiki.ts).
You can support either one of them, or both. Refer to the default theme for configurations examples [`./styles/prism.css`](https://github.com/slidevjs/slidev/blob/main/packages/theme-default/styles/prism.css) / [`./setup/shiki.ts`](https://github.com/slidevjs/slidev/blob/main/packages/theme-default/setup/shiki.ts).

Also, remember to provide the information in `package.json`
Also, remember to specify the supported highlighters in your `package.json`

```json
// package.json
Expand Down

0 comments on commit fd89371

Please sign in to comment.