Skip to content

SHUAXINDIARY/vuepress-theme-stella

Repository files navigation

Introduction

  • Hi there ! Stella is a Gatsby Theme, design by jctaoo, But now if you are vuepress2.x users, now you can use Stella too!
  • English | Chinese

Overview

Usage

install

mkdir stella-demo

yarn init -y # or npm init -y

yarn add vuepress

yarn add vuepress-theme-stella

write blog

All blog files should be in the post directory

add About Page

Create a directory called about , Then add a file called README.md

category

---
title: MD样式测试
category:
    - 技术
tag:
    - MarkDown
---

themeConfig

interface ICommon {
  label: string;
  link: string;
}

type Ifooter = ICommon;
type Icons = ICommon;
type Icates = ICommon;

interface ThemeConfig extends VupressSiteConfig {
  shiki?: HighlighterOptions;
  footer?: string | Ifooter;
  cates?: Icates[];
  icons?: Icons[];
}

TODO

  • config other link
  • follow system mode (dark/light)
  • markdown style of stella
  • passage filter by category 、tag
  • config default page ON-OFF
  • comment system
  • mobile adaptation
  • pagination
  • post banner img
  • site search
  • friend link
  • clipboard-plugin
  • comment-plugin
  • code snippets

License

License: MIT

LICENSE file