A api-friendly theme for VuePress. Inspired by zeit.
There are some global dependencies you need to set up.
# 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 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',
}
# Create a markdown file and write something
echo '# Hello, World.' > Hello.md
# Start writing
vuepress dev .
# Build to static files
vuepress build .
Go to docs to get more details.
A out-of-the-box starter kit for RESTful API document is here.
Author: sqrthree
Live Demo: https://blog.sqrtthree.com/vuepress-theme-api/
GitHub: https://github.com/sqrthree/vuepress-theme-api
#vuejs #vue #javascript #vue-js