Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
.gitignore
LICENSE
README.md
package.json
yarn.lock

README.md

vuepress-theme-api-starter-kit

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

image

Built With

Prerequisites

There are some global dependencies you need to set up.

Getting Started

$ git clone https://github.com/sqrthree/vuepress-theme-api-starter-kit.git
$ cd vuepress-theme-api-starter-kit
$ yarn # OR npm install

As Easy as 1, 2, 3

# Install vuepress
yarn global add vuepress # OR npm install -g vuepress

# Install theme
yarn global add vuepress-theme-api # OR npm install -g vuepress-theme-api

# Create a markdown file and write something
echo '# Hello, World.' > docs/Hello.md

# Start writing
vuepress dev docs # OR yarn run docs:dev OR npm run docs:dev

# Build to static files
vuepress build docs # OR yarn run docs:build OR npm run docs:build

# Static server
yarn run docs:serve # OR npm run docs:serve

Configuration

See vuepress-theme-api to get more details.


sqrtthree.com  ·  GitHub @sqrthree  ·  Twitter @sqrtthree