Skip to content

laplacetw/vitepress-theme-trigger

Repository files navigation

Node.js >= 18.0.0 VitePress 1.1.0

vitepress-theme-trigger

Blog theme for VitePress with Tailwind CSS.

Introduction

"Trigger" is a out-of-the-box VitePress theme, named after my favorite Anime "World Trigger". You can use it directly or customize it to better suit your needs.

More info about customization :

If there has any problem please feel free to create issue.

Changelog

Detailed changes are documented in the CHANGELOG.

Features

  • create new post with CLI
  • style with Tailwind CSS (RWD)
  • style for light / dark mode
  • pagination with History API
  • built-in sitemap generation
  • common use config integration
  • utterances for blog comments
  • sync light / dark mode for utterances
  • MathJax style optimization for mobile
  • prev / next links without fontmatter setting
  • support footnote by markdown-it-footnote

Prerequisite

Usage

# install devDependencies
(p)npm install

# create new post under /posts
(p)npm run new {new-post-filename}

# start local dev server
(p)npm run dev

# build for production
(p)npm run build

# Locally preview the production build
(p)npm run preview

Deploy

Our project includes the GitHub workflow. You just need to ensure that the themeConfig.base is properly configured and GitHub pages auto-deployment will be triggered after push to GitHub.

# amplify.yml
version: 1
frontend:
  phases:
    preBuild:
      commands:
        - nvm use 18
        - npm install -g pnpm
        - pnpm install --no-frozen-lockfile
    build:
      commands:
        - pnpm run build
  artifacts:
    baseDirectory: ./.vitepress/dist
    files:
      - '**/*'
  cache:
    paths:
      - node_modules/**/*

Reference

About

Blog theme for VitePress with Tailwind CSS. 為建立部落格而生的 VitePress 主題

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published