vuepress-theme-api-starter-kit

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

Built With

• Node.js
• VuePress

Prerequisites

There are some global dependencies you need to set up.

• Node.js
• VuePress
• vuepress-theme-api

Getting Started

$ npx degit sqrthree/vuepress-theme-api-starter-kit/docs

or with git clone:

$ 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

# Start writing
npm run dev

# Build for production
npm run build

# Locally preview production build
npm run serve

Configuration

See vuepress-theme-api to get more details.

---

sqrtthree.com  ·  GitHub @sqrthree  ·  Twitter @sqrtthree