Skip to content

Commit

Permalink
update readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hetari committed Oct 5, 2024
1 parent 82448a9 commit 37d7b1f
Show file tree
Hide file tree
Showing 20 changed files with 48 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![NPM version](https://img.shields.io/npm/v/vuejs-code-block.svg)](https://www.npmjs.com/package/vuejs-code-block)

Documentation: [https://vuejs-code-block.netlify.app/](https://vuejs-code-block.netlify.app/)

> [!IMPORTANT]
> For now this package has default themes, but in the future, it will be fully unstyled, allowing you to style it however you like.
Expand Down Expand Up @@ -114,3 +116,26 @@ greet('World');
</script>
```
-->
## Themes:

| Theme Name | Image |
| --------------------------- | --------------------------------------------------------------------- |
| Dracula | ![Dracula Theme](./docs/public/draculaTheme.webp) |
| Duotone Dark | ![Duotone Dark Theme](./docs/public/duotoneDarkTheme.webp) |
| Duotone Light | ![Duotone Light Theme](./docs/public/duotoneLightTheme.webp) |
| GitHub | ![GitHub Theme](./docs/public/githubTheme.webp) |
| Night Owl | ![Night Owl Theme](./docs/public/nightOwlTheme.webp) |
| None | ![None](./docs/public/none.webp) |
| Oceanic Next | ![Oceanic Next Theme](./docs/public/oceanicNextTheme.webp) |
| Prism Dark | ![Prism Dark Theme](./docs/public/prismDarkTheme.webp) |
| Prism Funky | ![Prism Funky Theme](./docs/public/prismFunkyTheme.webp) |
| Prism Okaidia | ![Prism Okaidia Theme](./docs/public/prismOkaidiaTheme.webp) |
| Prism Solarized Light Theme | ![Prism Solarized Light](./docs/public/prismSolarizedLightTheme.webp) |
| Prism | ![Prism Theme](./docs/public/prismTheme.webp) |
| Prism Theme Coy | ![Prism Theme Coy](./docs/public/prismThemeCoy.webp) |
| Prism Tomorrow | ![Prism Tomorrow Theme](./docs/public/prismTomorrowTheme.webp) |
| Prism Twilight | ![Prism Twilight Theme](./docs/public/prismTwilightTheme.webp) |
| Shades of Purple | ![Shades of Purple](./docs/public/shadesOfPurple.webp) |
| UltraMin | ![UltraMin Theme](./docs/public/ultraminTheme.webp) |
| VS Dark | ![VS Dark Theme](./docs/public/vsDarkTheme.webp) |
23 changes: 23 additions & 0 deletions docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,29 @@ greet('World');
```
-->
## Themes:

| Theme Name | Image |
| --------------------------- | ---------------------------------------------------------------- |
| Dracula | ![Dracula Theme](./images/draculaTheme.webp) |
| Duotone Dark | ![Duotone Dark Theme](./images/duotoneDarkTheme.webp) |
| Duotone Light | ![Duotone Light Theme](./images/duotoneLightTheme.webp) |
| GitHub | ![GitHub Theme](./images/githubTheme.webp) |
| Night Owl | ![Night Owl Theme](./images/nightOwlTheme.webp) |
| None | ![None](./images/none.webp) |
| Oceanic Next | ![Oceanic Next Theme](./images/oceanicNextTheme.webp) |
| Prism Dark | ![Prism Dark Theme](./images/prismDarkTheme.webp) |
| Prism Funky | ![Prism Funky Theme](./images/prismFunkyTheme.webp) |
| Prism Okaidia | ![Prism Okaidia Theme](./images/prismOkaidiaTheme.webp) |
| Prism Solarized Light Theme | ![Prism Solarized Light](./images/prismSolarizedLightTheme.webp) |
| Prism | ![Prism Theme](./images/prismTheme.webp) |
| Prism Theme Coy | ![Prism Theme Coy](./images/prismThemeCoy.webp) |
| Prism Tomorrow | ![Prism Tomorrow Theme](./images/prismTomorrowTheme.webp) |
| Prism Twilight | ![Prism Twilight Theme](./images/prismTwilightTheme.webp) |
| Shades of Purple | ![Shades of Purple](./images/shadesOfPurple.webp) |
| UltraMin | ![UltraMin Theme](./images/ultraminTheme.webp) |
| VS Dark | ![VS Dark Theme](./images/vsDarkTheme.webp) |

## Useful Links

- [GitHub Repository](https://github.com/hetari/vuejs-code-block)
Binary file added docs/public/draculaTheme.webp
Binary file not shown.
Binary file added docs/public/duotoneDarkTheme.webp
Binary file not shown.
Binary file added docs/public/duotoneLightTheme.webp
Binary file not shown.
Binary file added docs/public/githubTheme.webp
Binary file not shown.
Binary file added docs/public/nightOwlTheme.webp
Binary file not shown.
Binary file added docs/public/none.webp
Binary file not shown.
Binary file added docs/public/oceanicNextTheme.webp
Binary file not shown.
Binary file added docs/public/prismDarkTheme.webp
Binary file not shown.
Binary file added docs/public/prismFunkyTheme.webp
Binary file not shown.
Binary file added docs/public/prismOkaidiaTheme.webp
Binary file not shown.
Binary file added docs/public/prismSolarizedLightTheme.webp
Binary file not shown.
Binary file added docs/public/prismTheme.webp
Binary file not shown.
Binary file added docs/public/prismThemeCoy.webp
Binary file not shown.
Binary file added docs/public/prismTomorrowTheme.webp
Binary file not shown.
Binary file added docs/public/prismTwilightTheme.webp
Binary file not shown.
Binary file added docs/public/shadesOfPurple.webp
Binary file not shown.
Binary file added docs/public/ultraminTheme.webp
Binary file not shown.
Binary file added docs/public/vsDarkTheme.webp
Binary file not shown.

0 comments on commit 37d7b1f

Please sign in to comment.