Skip to content

lisniuse/vuepress-theme-thindark

Repository files navigation

vuepress-theme-thindark

npm npm code style: prettier

A dark theme for VuePress. (It is remodeled from the default theme and is compatible with all configurations of the default theme.)

Live demo

Built With

Prerequisites

There are some global dependencies you need to set up.

Getting Started

Installing

# Install vuepress
yarn global add vuepress # OR npm install -g vuepress

# Install theme
yarn global add vuepress-theme-thindark # OR npm install -g vuepress-theme-thindark

Configuration

Create VuePress config file .vuepress/config.js and provide a theme option.

// .vuepress/config.js
module.exports = {
  title: 'Hello, World.',
  description: 'Dark theme for VuePress.',
  theme: 'thindark',
}

As Easy as 1, 2, 3

# Create a markdown file and write something
echo '# Hello, World.' > Hello.md

# Start writing
vuepress dev .

# Build to static files
vuepress build .

How to use?

Go to docs to get more details.