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

https://github.com/packingjs/packing-template

Packing Template
https://github.com/packingjs/packing-template

Last synced: 2 months ago
JSON representation

Packing Template

Awesome Lists containing this project

README

          

# packing-template

这是 Packing 前端开发工具用来处理网页模版的工具包。本包提供两个方法:

- middleware
- plugin

这两个方法的参数可以通过下面两种方式传入:

- 在函数调用处通过 `options` 传入。这种方式传入的参数对所有 entry points 都有效。
- 通过与 `${entry}.js` 同目录的 `${entry}.settings.js` 配置文件传入。这种方式传入的参数仅对单一 entry point 有效。

```js
import path from 'path';

export default {
template: path.resolve(__dirname, 'template.html'),
title: 'Page A',
keywords: 'A AA',
description: 'A simple text',
attrs: ['img:src', 'link:href', 'script:src'],
city: 'Beijing'
};

```

## middleware
这是一个 [express](https://expressjs.com) 中间件,提供开发环境下网页自动生成、脚本注入的功能。

### 用法
```js
import Express from 'express';
import { middleware } from 'packing-template';

const app = new Express();

middleware(app, appConfig, {
template: path.resolve(__dirname, 'template.html'),
// inject: 'head',
// favicon: 'xxx.png'
// charset: 'gb2312'
});
```

### 参数
#### app
[express](https://expressjs.com) 实例。

#### appConfig
packing 配置。

#### options
可选参数:

##### template
类型: `String`

默认值: `node_modules/packing-template/templates/default.html`

模版文件的绝对路径。

##### inject
类型: `String`

默认值: `body`

可选值:
- body: 插入在