https://github.com/koa-modules/serve-list

Serve directory listings for koa, based on Express's serve-index.
https://github.com/koa-modules/serve-list

Last synced: 2 months ago
JSON representation

Serve directory listings for koa, based on Express's serve-index.

• Host: GitHub
• URL: https://github.com/koa-modules/serve-list
• Owner: koa-modules
• License: mit
• Created: 2015-04-02T23:14:04.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-30T02:19:38.000Z (over 8 years ago)
• Last Synced: 2024-04-14T23:55:49.621Z (3 months ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE

Lists

• awesome-koa - koa-serve-list - 基于 Express 的 `serve-index` 为 koa 提供目录列表。   (仓库 / 中间件)

README

        
# koa-serve-list

> Serves pages that contain directory listings for a given path for koa.  

> [serve-index] wrapper for koa's middleware.

[![NPM version][npm-img]][npm-url]

[![NPM Downloads][downloads-image]][npm-url]

[![Build status][travis-img]][travis-url]

[![Test coverage][coveralls-img]][coveralls-url]

[![Dependency status][david-img]][david-url]

[![License][license-img]][license-url]

## Install

```sh

$ npm install --save koa-serve-list

```

## Usage

### **=1.x**, 100%, working with `koa-v2`

```js

const Koa = require('koa');

const serveList = require('koa-serve-list');

const serveStatic = require('koa-serve-static');

const app = new Koa();

app.use(serveList(path, options));

app.use(serveStatic(root, options));

app.listen(3000);

```

### **<1.x**

```js

var koa = require('koa');

var serveList = require('koa-serve-list');

var serveStatic = require('koa-serve-static');

var app = koa();

app.use(serveList(path, options));

app.use(serveStatic(root, options));

app.listen(3000);

```

[npm-img]: https://img.shields.io/npm/v/koa-serve-list.svg?style=flat-square

[npm-url]: https://npmjs.org/package/koa-serve-list

[travis-img]: https://img.shields.io/travis/koa-modules/serve-list.svg?style=flat-square

[travis-url]: https://travis-ci.org/koa-modules/serve-list

[coveralls-img]: https://img.shields.io/coveralls/koa-modules/serve-list.svg?style=flat-square

[coveralls-url]: https://coveralls.io/r/koa-modules/serve-list?branch=master

[license-img]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square

[license-url]: LICENSE

[david-img]: https://img.shields.io/david/koa-modules/serve-list.svg?style=flat-square

[david-url]: https://david-dm.org/koa-modules/serve-list

[downloads-image]: https://img.shields.io/npm/dm/koa-serve-list.svg?style=flat-square

[serve-index]: https://github.com/expressjs/serve-index