vuepress-theme-api

by sqrthree

πŸ“¦πŸ“πŸŽ¨A api-friendly theme for VuePress.

241 Stars 41 Forks Last release: 8 months ago (v0.2.4) MIT License 72 Commits 14 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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

npm npm code style: prettier

πŸ“¦ πŸ“ 🎨 A api-friendly theme for VuePress. Inspired by zeit.

Live demo

image

Built With

Prerequisites

There are some global dependencies you need to set up.

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.