Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linhe0x0/vuepress-theme-api

📦📝🎨 A api-friendly theme for VuePress.
https://github.com/linhe0x0/vuepress-theme-api

api-friendly-theme vuepress vuepress-theme

Last synced: 18 days ago
JSON representation

📦📝🎨 A api-friendly theme for VuePress.

Host: GitHub
URL: https://github.com/linhe0x0/vuepress-theme-api
Owner: linhe0x0
License: mit
Created: 2018-05-17T15:06:25.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-01-13T00:04:57.000Z (almost 2 years ago)
Last Synced: 2024-10-13T21:32:03.447Z (26 days ago)
Topics: api-friendly-theme, vuepress, vuepress-theme
Language: Vue
Homepage: https://blog.sqrtthree.com/vuepress-theme-api/
Size: 2.46 MB
Stars: 350
Watchers: 5
Forks: 64
Open Issues: 17
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-starred - linhe0x0/vuepress-theme-api - 📦📝🎨 A api-friendly theme for VuePress. (others)

README

        # vuepress-theme-api

[![npm](https://img.shields.io/npm/v/vuepress-theme-api.svg)](https://www.npmjs.com/package/vuepress-theme-api)

[![npm](https://img.shields.io/npm/l/vuepress-theme-api.svg)](https://github.com/sqrthree/vuepress-theme-api/blob/master/LICENSE)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

> 📦 📝 🎨 A api-friendly theme for VuePress. Inspired by [zeit](https://zeit.co/docs).

[Live demo](https://blog.sqrtthree.com/vuepress-theme-api/)

[![image](https://user-images.githubusercontent.com/8622362/40341249-9b6e8b9e-5db6-11e8-97f5-41cadc87ce51.png)](https://github.com/sqrthree/vuepress-theme-api-starter-kit)

## Built With

- [Node.js](https://nodejs.org/)

- [VuePress](https://github.com/vuejs/vuepress)

## Prerequisites

There are some global dependencies you need to set up.

- [Node.js](https://nodejs.org/)

- [VuePress](https://github.com/vuejs/vuepress)

## Getting Started

### Installing

```bash

# Install VuePress

yarn add vuepress # OR npm install vuepress

# Install theme

yarn add vuepress-theme-api # OR npm install vuepress-theme-api

```

### Configuration

Create VuePress config file `.vuepress/config.js` and provide a `theme` option.

```js

// .vuepress/config.js

module.exports = {

  title: 'Hello, World.',

  description: '📦 🎨 A api-friendly theme for VuePress.',

  theme: 'api',

}

```

### As Easy as 1, 2, 3

```bash

# 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](https://blog.sqrtthree.com/vuepress-theme-api/) to get more details.

## Starter kit

A out-of-the-box starter kit for RESTful API document is [here](https://github.com/sqrthree/vuepress-theme-api-starter-kit).

---

> [sqrtthree.com](http://sqrtthree.com/)  · 

> GitHub [@sqrthree](https://github.com/sqrthree)  · 

> Twitter [@sqrtthree](https://twitter.com/sqrtthree)