Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m2de/vuepress-tailwind-starter
A boilerplate setup for VuePress with Tailwind CSS
https://github.com/m2de/vuepress-tailwind-starter
Last synced: about 2 months ago
JSON representation
A boilerplate setup for VuePress with Tailwind CSS
- Host: GitHub
- URL: https://github.com/m2de/vuepress-tailwind-starter
- Owner: m2de
- Created: 2019-01-13T16:52:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-05-04T07:34:47.000Z (over 5 years ago)
- Last Synced: 2024-04-03T14:32:04.420Z (6 months ago)
- Language: HTML
- Size: 353 KB
- Stars: 29
- Watchers: 4
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VuePress Tailwind Starter Theme
This boilerplate repository is designed to serve as a starting point for creating custom websites with VuePress. Because it replaces the original theme entirely, a lot of out-of-the-box functionality you get with the default VuePress installation is not available.
You can preview the [live demo](https://vuepress-tailwind-starter.netlify.com/) for this [Github Repo](https://github.com/m2de/vuepress-tailwind-starter) hosted on [Netlify](https://www.netlify.com/).
PurgeCSS is used during the build process to keep the CSS bundle size as small as possible.
## Why VuePress
The reason for using VuePress over other platforms like [Nuxt](https://nuxtjs.org) or [Jigsaw](https://jigsaw.tighten.co/) is because VuePress offers a way to keep your content primarily in Markdown whilst providing a super lightweight tooling setup. It provides server side rendering (SSR) for search engine optimisation (SEO) and can easily be used with services like Netlify to automate the build and deployment process. Finally, you get the full power of [Vue.js](https://vuejs.org) to build out any advanced functionality, even inside Markdown files.
## How to use this starter theme
Clone the repository
```sh
git clone [email protected]:m2de/vuepress-tailwind-starter.git my-project
```
Re-initialise the git repository
```sh
cd my-project && rm -Rf .git && git init
```
## Building for development
Run the project and access the site via `http://localhost:8080`
```sh
npm run dev
```
## Building for production
```sh
npm run build
```
## Roadmap
* [x] Fix dev build to run without Purge Css
* [x] Import Tailwind and Purge CSS through VuePress Plugins
* [ ] Compile into regular installable VuePress theme. Challenge will be the Tailwind config (also waiting for 1.0)
* [ ] Add more out of the box functionality like Nav and Search
## Support
Any contributions to this package are welcome. Look me up on Twitter [@m2de_io](https://twitter.com/m2de_io), I'd love to hear from anyone with feedback and see what you have created using VuePress and Tailwind.