https://github.com/linhe0x0/vuepress-theme-api-starter-kit
📦:art: A starter kit for https://github.com/sqrthree/vuepress-theme-api
https://github.com/linhe0x0/vuepress-theme-api-starter-kit
Last synced: 10 days ago
JSON representation
📦:art: A starter kit for https://github.com/sqrthree/vuepress-theme-api
- Host: GitHub
- URL: https://github.com/linhe0x0/vuepress-theme-api-starter-kit
- Owner: linhe0x0
- License: mit
- Created: 2018-05-21T02:22:09.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T06:24:25.000Z (about 2 years ago)
- Last Synced: 2025-04-10T02:44:28.345Z (24 days ago)
- Homepage:
- Size: 1.98 MB
- Stars: 22
- Watchers: 2
- Forks: 11
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - linhe0x0/vuepress-theme-api-starter-kit - 📦:art: A starter kit for https://github.com/sqrthree/vuepress-theme-api (others)
README
# vuepress-theme-api-starter-kit
[]()
> A out-of-the-box starter kit for https://github.com/sqrthree/vuepress-theme-api.
## Built With
- [Node.js](https://nodejs.org/)
- [VuePress](https://github.com/vuejs/vuepress)
## Prerequisites
There are some global dependencies you need to set up.
- [Node.js](https://nodejs.org/)
- [VuePress](https://github.com/vuejs/vuepress)
- [vuepress-theme-api](https://github.com/sqrthree/vuepress-theme-api)
## Getting Started
```bash
$ npx degit sqrthree/vuepress-theme-api-starter-kit/docs
```
or with `git clone`:
```bash
$ git clone https://github.com/sqrthree/vuepress-theme-api-starter-kit.git
$ cp -r vuepress-theme-api-starter-kit/docs your_doc_dir
$ cd your_doc_dir && npm install
```
## As Easy as 1, 2, 3
```bash
# Start writing
npm run dev
# Build for production
npm run build
# Locally preview production build
npm run serve
```
## Configuration
See [vuepress-theme-api](https://github.com/sqrthree/vuepress-theme-api#vuepress-theme-api) to get more details.
---
> [sqrtthree.com](http://sqrtthree.com/)  ·Â
> GitHub [@sqrthree](https://github.com/sqrthree)  ·Â
> Twitter [@sqrtthree](https://twitter.com/sqrtthree)