https://github.com/xiaoluoboding/vuepress-tailwind-theme-starter

A starter of build VuePress Theme with TailwindCss.
https://github.com/xiaoluoboding/vuepress-tailwind-theme-starter

starter-template tailwindcss vuepress vuepress-theme

Last synced: 2 months ago
JSON representation

A starter of build VuePress Theme with TailwindCss.

• Host: GitHub
• URL: https://github.com/xiaoluoboding/vuepress-tailwind-theme-starter
• Owner: xiaoluoboding
• License: mit
• Created: 2020-03-24T11:09:28.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-13T00:11:25.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T02:43:08.327Z (3 months ago)
• Topics: starter-template, tailwindcss, vuepress, vuepress-theme
• Language: Stylus
• Homepage: https://vuepress-tailwind-theme-starter.now.sh/
• Size: 1.84 MB
• Stars: 15
• Watchers: 2
• Forks: 3
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tailwindcss - VuePress Tailwind CSS Starter - A VuePress starter using Tailwind CSS. (Starters & Themes)

README

        
# VuePress TailwindCss Theme Starter

A starter of build VuePress theme with tailwindcss.

`VuePress` provides a lot of out of the box functionality tools you can use in your custom theme,

`Tailwind CSS` provides low-level utility-first classes that buiding responsive interfaces quickly.

Now we got the power of VuePress + Tailwind CSS + Vue.js, Let's build a beautiful Website with these powerful tech stacks.

![VuePress + Tailwind](./.vuepress/public/images/vuepress+tailwindcss.png)

## Usage & Development

> 💡 VuePress requires Node.js >= 8.6.

### Clone This Repo

you can clone this repo and rename it.

```bash

git clone https://github.com/xiaoluoboding/vuepress-tailwind-theme-starter NEW_THEME_NAME

```

### Installation

```bash

yarn

or

npm install

```

### Start Using Theme

```bash

yarn dev

or

npm run dev

```

### build to static files

```bash

yarn build

or

npm run build

```

## Developing a Plugin

This project is perfert for developing plugins for VuePress / TailwindCss. You can use it as a playground.

I developed two plugins for VuePress:

* [VuePress Plugin GeoPattern](https://github.com/xiaoluoboding/vuepress-plugin-geopattern)

* [VuePress Plugin HeroPattern](https://github.com/xiaoluoboding/vuepress-plugin-hero-pattern)

## Deploy to vercel

[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/xiaoluoboding/vuepress-tailwind-theme-starter)

## Official Documents

* [VuePress](https://vuepress.vuejs.org/guide/getting-started.html#quick-start)

* [TailwindCss](https://tailwindcss.com/)

## License

MIT [@xiaoluoboding](https://github.com/xiaoluoboding)