Git Product home page Git Product logo

vuepress-theme-hope's Introduction

vuepress-theme-hope

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

Author: Mr.Hope License

Version Downloads Size

DeepScan grade CodeQL codecov Test theme

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

Warning

Current branch is based on VuePress@v2, and still in W.I.P. For stable releasae in v1, please see v1 branch.

当前分支基于 VuePress@v2,仍处于 W.I.P. 稳定 v1 发行版请参见v1 分支

Details

V2 will come together with VuePress@v2, with the power of vite@v2 webpack@v5 and vue@v3.

V2 will be a totally rewrite including:

  • All the components will be rewrite with composition api in vue3
  • All the styles will be mirgate to sass

Also we are going to make sure the rewrite one has a better performance!🚀 (no less than 25% increasement)


Here is a list of changes:

Note: All plugin names are in PascalCase and without vuepress-plugin- prefix, you should change to kebab-case and add the prefix yourself to get the correct plugin name.

AddThis💌 deprecated

We are just making this plugin compatable with V2. This plugin will no longer under maintainment.

Why❔

AdBlocks are blocking addThis link heavily, and in most cases this plugin won't work.

Solution💡

We will provide a new share plugin in v2.

Comment2💬

Renamed from @mr-hope/vuepress-plugin-comment to vuepress-plugin-comment2. ⚠

Changes

  • Drop Valine support! removed

    Valine is lack of maintainence and can leak your privacy. You should use Waline instead.

  • Option hint (default true) for handling page info hints. new

  • Allow I18N Customize new

  • Muti categories support new

Note

Vssue is currently being dropped because vssue has not support v2 yet. We will add it back after it supports v2.

CopyCode2📋

Renamed from @mr-hope/vuepress-plugin-copy-code to vuepress-plugin-copy-code2. ⚠

Changes

  • Option delay (default 500) for handling the page swtiching transition. new

  • Option pure (default false) for handling fancy styles. new

  • Allow I18N Customize new

Feed2

Renamed from @mr-hope/vuepress-plugin-feed to vuepress-plugin-feed2. ⚠

Changes

  • Better log output. improve

  • Muti categories support new

MdEnhance

Changes

  • Auto inject cdn links for markdown demo new

  • Option delay (default 500) for handling the page swtiching transition. new

  • Drop flowchart support removed

    We are adding mermaid support, and mermaid support flowchart.

  • Move SlidePage layout from theme to the plugin

  • Allow I18N Title in details block new

  • Allow I18N Customize new

LightGallery new

Pwa2

Renamed from @mr-hope/vuepress-plugin-pwa to vuepress-plugin-pwa2. ⚠

Changes

  • Allow I18N Customize new

PhotoSwipe deprecated

This plugin will still be under maintained, but we are going to build a better plugin using lightGallary.

Changes

  • Option delay (default 500) for handling the page swtiching transition. new

  • Allow I18N Customize new

ReadingTime2

Renamed from @mr-hope/vuepress-plugin-reading-time to vuepress-plugin-reading-time2. ⚠

  • Allow I18N Customize new

SassPalette new

  • A new palette handling config and palette across theme and plugins using sass

Options:

export interface PaletteOptions {
  /** identifier for palette */
  id: string;

  /**
   * user config file path, relative to source dir
   *
   * @default ".vuepress/styles/config.scss"
   */
  config?: string;

  /**
   * default config file path, should be absolute path
   *
   * This is the file you should use to provide default values with `!default`
   *
   * @default "vuepress-plugin-sass-palette/styles/default/config.scss"
   */
  defaultConfig?: string;

  /**
   * user palette file path, relative to source dir
   *
   * @default ".vuepress/styles/palette.scss"
   */
  palette?: string;

  /**
   * default palette file path, should be absolute path
   *
   * This is the file you should use to provide default values with `!default`
   *
   * @default "vuepress-plugin-sass-palette/styles/default/palette.scss"
   */

  defaultPalette?: string;

  /**
   * user style file path, relative to source dir
   *
   * @default ".vuepress/styles/palette.scss"
   */
  style?: string;
}

SEO2

Renamed from @mr-hope/vuepress-plugin-seo to vuepress-plugin-seo2. ⚠

Changes

  • JSON-LD support new

  • Better log output. improve

  • Muti categories support new

  • Alternate Language Link support new

Share2 new

  • A new share plugin providing page share.

SimpleBlog new

  • Build a own blog plugin to support blog with better performance

Sitemap2

Renamed from @mr-hope/vuepress-plugin-sitemap to vuepress-plugin-sitemap2. ⚠

Changes

  • Better log output. improve

  • Muti categories support new

VuepressThemeHope

  • Pure Mode in theme and all plugins #438 new

  • Dim non focused area #168 new

  • Code block theme config #189 new

  • Muti categories support new

  • Drop fullscreen feature, or make it a optional feature (disabled by default). removed

    Most visitors do not use this feature.

  • Drop themecolor feature, or make it a optional feature (disabled by default). removed

    Most visitors do not use this feature.

  • Allow I18N Customize new

vuepress-theme-hope's People

Contributors

mister-hope avatar jiazengp avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.