Need help with vuepress-theme-api?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sqrthree
255 Stars 47 Forks MIT License 73 Commits 7 Opened issues

Description

📦📝🎨A api-friendly theme for VuePress.

Services available

!
?

Need anything else?

Contributors list

# 187
vue2
React
transla...
Swift
68 commits
# 623,677
JavaScr...
1 commit
# 143,879
pomodor...
time-ma...
Electro...
TypeScr...
1 commit
# 446,243
JavaScr...
HTML
authent...
Django
1 commit

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.