Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 15 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 (almost 2 years ago)
Last Synced: 2024-11-06T22:02:54.752Z (4 months ago)
Homepage:
Size: 1.98 MB
Stars: 22
Watchers: 3
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

[![](https://img.shields.io/badge/version-v0.1.1-brightgreen.svg)]()

> A out-of-the-box starter kit for https://github.com/sqrthree/vuepress-theme-api.

![image](https://user-images.githubusercontent.com/8622362/40341249-9b6e8b9e-5db6-11e8-97f5-41cadc87ce51.png)

## 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)