# vuepress-theme-hope

**Repository Path**: sync-github/theme

## Basic Information

- **Project Name**: vuepress-theme-hope
- **Description**: 一个功能强大的vuepress主题
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: v1
- **Homepage**: https://vuepress-theme-hope.github.io/zh/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 32
- **Created**: 2021-03-26
- **Last Updated**: 2024-04-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!-- markdownlint-disable -->
<p align="center">
  <img width="240" src="https://vuepress-theme-hope.github.io/logo.svg" style="text-align: center;"/>
</p>
<h1 align="center">vuepress-theme-hope</h1>
<h4 align="center">A vuepress theme with tons of features✨ / 一个具有强大功能的 vuepress 主题✨</h4>

[![Author: Mr.Hope](https://img.shields.io/badge/作者-Mr.Hope-blue.svg?style=for-the-badge)](https://mrhope.site) [![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/v1/LICENSE)

<!-- 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) ![Size](https://img.shields.io/bundlephobia/min/vuepress-theme-hope?style=flat-square&logo=npm)](https://www.npmjs.com/package/vuepress-theme-hope)

[![DeepScan grade](https://deepscan.io/api/teams/9792/projects/15720/branches/318414/badge/grade.svg)](https://deepscan.io/dashboard/#view=project&tid=9792&pid=15720&bid=318414)
![CodeQL](https://github.com/vuepress-theme-hope/vuepress-theme-hope/actions/workflows/codeql-analysis.yml/badge.svg)
[![codecov](https://codecov.io/gh/vuepress-theme-hope/vuepress-theme-hope/branch/v1/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/test.yml/badge.svg)

A vuepress theme with tons of features✨ / 一个具有强大功能的 vuepress 主题 ✨

## Official Docs / 官方文档

[English Docs](https://vuepress-theme-hope.github.io/) | [中文文档](https://vuepress-theme-hope.github.io/zh/) | [Gitee 镜像](#gitee-镜像)

[Theme Highlights](#Theme-Highlights) | [主题特点](#主题特点)

## Theme Highlights

The theme maintains the style of the `@vuepress/theme-default`, and adds a lot of features and optimizations:

### Markdown Enhance

Added more syntax to Markdown, enriching documentation and blog writing

- Tex support
- Custom alignment
- Flow chart
- Mark
- Subsript and Supercript
- Code Demo
- Presentation

### Page Enhance

- Picture preview feature, supports:

  - zooming
  - dragging
  - sliding browsing
  - sharing
  - downloading

- Article information display

  - Reading Counts
  - Author and writing date
  - Automatically generated word count and estimated reading time
  - Tags and Categorys

- Comment System

- BreadCrumbs

- Page Icon

- Copyright display

- Customizable footer

### Features

#### Out of box

- Brand new theme colors, allowing you to switch dynamically during browsing

- Dark mode, allowing you to switch manually or apply automatically according to device settings

- Full screen button

- PWA support

- Back to top button

- One-click copy code

- Add copyright information when copying

#### More powerful features

- Feed generation

- SEO enhancement

- Sitemap generation

- Encryption of specific articles and paths

- TypeScript Support

### Style optimization

- Icon support everywhere

- Default homepage optimization

  - Features have new animations and support jump
  - Multiple action buttons
  - Widescreen layout optimization

- Optimization of other built-in components

  - Back to top button style optimization
  - PWA popup optimization
  - Navigation bar and sidebar style optimization and group prefix support

### Blog section

- New blog homepage layout

- Social follow button and page social sharing

- Article display

  - Articles list swith sticky support
  - Cateory lists
  - Tag lists
  - Timeline

## 主题特点

主题很大程度上保持了 VuePress 默认主题的风格，并在此基础上添加了大量功能与优化:

### Markdown 增强

为 Markdown 添加了更多语法，丰富文档与博客写作

- Tex 支持
- 自定义对齐
- 流程图
- 标记
- 上下角标
- 代码演示
- 幻灯片

### 页面增强

- 图片预览功能，支持:

  - 放大
  - 拖拽
  - 滑动浏览
  - 分享
  - 下载

- 文章信息展示

  - 阅读量统计
  - 作者与写作日期
  - 自动生成的字数与预计阅读时间
  - 标签与分类

- 评论系统

- 自定义页脚

- 版权显示

- 路径导航

### 功能增强

#### 零配置自动实现并允许你定制

- 全新主题色，允许你在浏览过程中动态切换

- 深色模式，允许你手动切换或者是根据设备设置自动应用

- 全屏按钮

- PWA 支持

- 返回顶部按钮

- 一键复制代码

- 复制时添加版权信息

#### 更多强大功能

- Feed 生成

- SEO 增强

- Sitemap 生成

- 支持对特定文章与路径进行加密

- TypeScript 支持

### 样式优化

- 多处图标支持

- 默认主页优化

  - 特性拥有全新动画并支持跳转
  - 多个动作按钮
  - 宽屏布局优化

- 其他内置组件优化

  - 返回顶部按钮样式优化
  - PWA 弹窗优化
  - 导航栏与侧边栏样式优化与分组前缀支持

### 博客部分

- 全新博客主页布局

- 社交关注按钮与页面社交分享

- 文章展示

  - 支持置顶的文章列表
  - 分类分组列表
  - 标签分组列表
  - 时间线

## Gitee 镜像

由于有些人无法访问 Github Pages 或速度很慢，我们在 Gitee 上部署了 [国内镜像](https://vuepress-theme-hope.gitee.io)。

请注意由于该镜像为手动部署，我们不保证它时刻与 Github Pages 的文档同步。