OpenApi Docs Theme

A VuePress theme that supports a dark theme, multiple color themes, and other useful features. Extended upon the default VuePress theme with some adjustments and YUU theme.

Installation

You can add openapi-the to your current VuePress project by running:

yarn add vuepress-theme-pdavim-openapi
# or npm install vuepress-theme-pdavim-openapi

And then setting it in your docs/.vuepress/config.js file:

module.exports = {
  theme: "pdavim-openapi",
};

Features and configuration

You can check out how to configure all of features and a live demo on the docs site.

md snipets

table of contents

[[toc]]

Components

YouTube

Usage: All you should need is the id of the YouTube video and you'll get a responsive full width embed.

<YouTube id="YOUTUBE_VIDEOID" />

example:

<YouTube id="tKjZuykKY1I" />

update

version 1.1.9

• components import correction
• added to package.json

"js-yaml": "^4.0.0",
"js-yaml-loader": "^1.2.2"

version 1.1.8

• no info

version 1.1.7

• no info

version 1.1.6

• added to pachage.json

"swagger-ui": "^3.33.0"

version 1.1.5

• added to pacjage.json

"@vuepress/plugin-active-header-links": "^1.8.2",
"@vuepress/plugin-back-to-top": "^1.9.7",
"@vuepress/plugin-last-updated": "^1.8.2",
"@vuepress/plugin-medium-zoom": "^1.9.7",

version 1.1.4

• no info

version 1.1.3

• added YouTube component
• general improvements