πŸ“¦πŸ“πŸŽ¨A api-friendly theme for VuePress.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
components πŸ› fix: Filter invalid sidebar items Sep 3, 2018
docs πŸ› fix: Fix "donot show multi-language options when setted the sidebar… Jul 22, 2018
styles πŸ‘½ πŸ› fix: Updating code due to API changes of VuePress May 26, 2018
.editorconfig πŸ› fix: Fix a careless issue May 24, 2018
.gitignore πŸ™ˆ πŸ”§ chore: Update .gitignore file and add a script to clean build files May 24, 2018
.npmignore πŸ™ˆ chore: Add .npmignore file May 24, 2018
.prettierignore 🎨 chore: Add lint script May 26, 2018
.prettierrc πŸŽ‰ feat: This is where it all begins... May 21, 2018
.travis.yml πŸ‘· ci(CI): Add CI build system May 26, 2018
Home.vue πŸ› fix(Home): Set a default value of page footer Jun 23, 2018
LICENSE Initial commit May 17, 2018
Layout.vue ♻️ refactor(config): Refactor configuration helper Jul 11, 2018
NotFound.vue ✨ feat: Add not-found page Jul 25, 2018
Page.vue πŸ’„ fix(styles): Impromve UI Jul 9, 2018
README.md πŸ“ docs(README.md): Update README.md May 30, 2018
config.js ♻️ refactor(config): Refactor configuration helper Jul 11, 2018
curl.js 🚨 chore: Remove linter warnings Jul 4, 2018
enhanceApp.js πŸŽ‰ feat: This is where it all begins... May 21, 2018
package-lock.json 0.2.1 Sep 14, 2018
package.json 0.2.1 Sep 14, 2018
request.js πŸŽ‰ feat: This is where it all begins... May 21, 2018
utils.js ♻️ refactor: Refactor i18n of sidebar Jul 22, 2018

README.md

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