recipe/README.md
2024-08-18 19:16:25 +08:00

73 lines
3.6 KiB
Markdown

<!-- markdownlint-disable -->
<p align="center">
<img width="240" src="https://theme-hope-assets.vuejs.press/logo.svg" style="text-align: center;">
</p>
<h1 align="center">vuepress-theme-hope</h1>
<h4 align="center">A VuePress theme with tons of features✨</h4>
<h4 align="center">
[中文簡介](README-zh.md) | [Russian README](https://github.com/vuepress-theme-hope/theme-ru-docs)
</h4>
[![Author: Mr.Hope](https://img.shields.io/badge/Author-Mr.Hope-blue.svg?style=for-the-badge)](https://mister-hope.com)
[![License](https://img.shields.io/npm/l/vuepress-theme-hope.svg?style=for-the-badge)](https://github.com/vuepress-theme-hope/vuepress-theme-hope/blob/main/LICENSE)
[![Open in Visual Studio Code](https://img.shields.io/badge/-open%20in%20vscode-blue?style=for-the-badge&logo=visualstudiocode)](https://open.vscode.dev/vuepress-theme-hope/vuepress-theme-hope)
<!-- markdownlint-restore -->
[![Version](https://img.shields.io/npm/v/vuepress-theme-hope.svg?style=flat-square&logo=npm) ![Downloads](https://img.shields.io/npm/dm/vuepress-theme-hope.svg?style=flat-square&logo=npm) ![Total downloads](https://img.shields.io/npm/dt/vuepress-theme-hope?style=flat-square&logo=npm)](https://www.npmjs.com/package/vuepress-theme-hope)
[![open collective](https://opencollective.com/vuepress-theme-hope/tiers/badge.svg)](https://opencollective.com/vuepress-theme-hope)
[![DeepScan grade](https://deepscan.io/api/teams/9792/projects/17544/branches/405512/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=9792&pid=17544&bid=405512)
![CodeQL](https://github.com/vuepress-theme-hope/vuepress-theme-hope/actions/workflows/codeql-analysis.yml/badge.svg)
[![code cov](https://codecov.io/gh/vuepress-theme-hope/vuepress-theme-hope/branch/main/graph/badge.svg?token=TNYMbGlxQ9)](https://codecov.io/gh/vuepress-theme-hope/vuepress-theme-hope)
![Test theme](https://github.com/vuepress-theme-hope/vuepress-theme-hope/actions/workflows/main.yml/badge.svg)
A VuePress theme with tons of features✨
## [English Docs](https://theme-hope.vuejs.press/)
## [Online Demo](https://stackblitz.com/fork/vuepress-theme-hope)
## Special Sponsor
[![Grey Software](https://vuepress-theme-hope.github.io/grey-software.svg)](https://grey.software/)
## Contact
We recommend you to contact using [issues](https://github.com/vuepress-theme-hope/vuepress-theme-hope/issues) and [discussions](https://github.com/vuepress-theme-hope/vuepress-theme-hope/discussions), but you are welcome to join our [telegram group!](https://t.me/vuepressthemehope).
## Details
V2 is based on [**VuePress2**](https://vuejs.press), with the power of [**Vite5**](https://vitejs.dev) / [**Webpack5**](https://webpack.js.org) using [**Vue3**](https://vuejs.org) to provide powerful features.
V2 is a full rewrite including:
- All the components are rewritten with **Composition API in Vue3**
- All the styles are migrated to **Sass**
Also V2 has a better performance:🚀
- DevServer cold start time reduced by **70%**
- Build memory usage reduced by **65%**
- Build time reduced by **75%**
- Output Size reduced by **45%**
- Webpage performance up to **60%**
## Project Status
![Status](https://repobeats.axiom.co/api/embed/1164cd0962fe9e8ce7fd3785cb28c79adecf8a26.svg)
## Contributors
Thanks to all the contributors!
[![contributors](https://contrib.rocks/image?repo=vuepress-theme-hope/vuepress-theme-hope)](https://github.com/vuepress-theme-hope/vuepress-theme-hope/graphs/contributors)
## Stargazers over time
[![Stargazers over time](https://starchart.cc/vuepress-theme-hope/vuepress-theme-hope.svg)](https://starchart.cc/vuepress-theme-hope/vuepress-theme-hope)