vuepress-theme-coding-api
📦 📝 🎨 A api-friendly theme for VuePress. Inspired by zeit. A fork of sqrtthree/vuepress-theme-api.
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-coding-api # OR npm install -g vuepress-theme-coding-api
Configuration
Create VuePress config file .vuepress/config.js
and provide a theme
option.
// .vuepress/config.jsmoduleexports = title: 'Hello, World.' description: '📦 🎨 A api-friendly theme for VuePress.' theme: 'coding-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.
Thanks For:
sqrtthree.com · GitHub @sqrthree · Twitter @sqrtthree