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.
📦 📝 🎨 A api-friendly theme for VuePress. Inspired by zeit.
There are some global dependencies you need to set up.
# Install vuepressyarn global add vuepress # OR npm install -g vuepress# Install themeyarn global add vuepress-theme-api # OR npm install -g vuepress-theme-api
Create VuePress config file
.vuepress/config.js and provide a
// .vuepress/config.jsmoduleexports =title: 'Hello, World.'description: '📦 🎨 A api-friendly theme for VuePress.'theme: 'api'
# Create a markdown file and write somethingecho '# Hello, World.' > Hello.md# Start writingvuepress dev .# Build to static filesvuepress build .
Go to docs to get more details.
A out-of-the-box starter kit for RESTful API document is here.