/vuepress-theme-gungnir

A blog theme for VuePress 2.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Gungnir V2

npm docs license awesome-vuepress

A blog theme for VuePress 2, WIP.

Gungnir is the spear of the god Odin in Norse mythology.

preview

 

Features

  • Simple and beautiful
  • Responsive design
  • Multi-level navigation
  • Switchable cover images for home page
  • Dark and light mode: system theme detection with a theme-switcher to set the theme as per the user preference
  • Search
  • Table of contents
  • Full screening the code blocks (inspired by WordPress theme Sakura)
  • Tex support (Katex)
  • Draw charts and graphs in Markdown easily: Chart.js, Mermaid
  • Markdown enhancements:
  • Analytics (Google Analytics and Baidu Tongji)
  • Comment (Giscus)
  • RSS
  • Reading time
  • Multi-language support (English, Simplified Chinese)
  • Archive page with tags and links page

TODO:

 

Installation

Please make sure you are using the latest version of VuePress (2.0.0-beta.49) and theme Gungnir.

pnpm install -D vuepress vuepress-theme-gungnir@next

 

Documentation & Live Demos

 

Plugins

This repository also contains the following plugins:

 

Changes (v0 -> v2)

 

Contribution

See Contributing Guide.

 

Other Versions

No further update expected for the following previous versions:

 

License

VuePress theme Gungnir is Apache License 2.0 licensed, see the LICENSE file for details.

Plugins are licensed by MIT.