v1.0.0 is beta, going to release in the next few days.

All planned features have been implemented. The documents will be updated in the next few days.

vuepress-theme-api

📦 📝 🎨 A api-friendly theme for VuePress. Inspired by zeit.

Live demo

Built With

• Node.js
• VuePress

Prerequisites

There are some global dependencies you need to set up.

• Node.js
• VuePress

Getting Started

Installing

# 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 

Configuration

Create VuePress config file .vuepress/config.js and provide a theme option.

// .vuepress/config.js
module.exports = {
  title: 'Hello, World.',
  description: '📦 🎨 A api-friendly theme for VuePress.',
  theme: 'api',
}

As Easy as 1, 2, 3

# Create a markdown file and write something 
echo '# Hello, World.' > Hello.md
 
# Start writing 
vuepress dev .
 
# Build to static files 
vuepress build .

How to use?

Go to docs to get more details.

Starter kit

A out-of-the-box starter kit for RESTful API document is here.

sqrtthree.com  ·  GitHub @sqrthree  ·  Twitter @sqrtthree