hexo-server

KO | EN

gitlite — search

#javascript #python #ai #typescript #llm #deep-learning #macos #nodejs #windows #awesome #kubernetes #awesome-list #pytorch #ios

(★ 81)

Server module for Hexo.

파일 탐색기

최종 버전 다운로드 (.zip)

- - tester.yml
- dependabot.yml
- - gzip.js
  - header.js
  - logger.js
  - redirect.js
  - route.js
  - static.js
- server.js
- .eslintrc
- .mocharc.yml
- index.js
.eslintignore
.eslintrc
.gitignore
index.js
LICENSE
package-lock.json
package.json
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# hexo-server

[![Build Status](https://github.com/hexojs/hexo-server/workflows/Tester/badge.svg)](https://github.com/hexojs/hexo-server/actions?query=workflow%3ATester)
[![NPM version](https://badge.fury.io/js/hexo-server.svg)](https://www.npmjs.com/package/hexo-server)
[![Coverage Status](https://img.shields.io/coveralls/hexojs/hexo-server.svg)](https://coveralls.io/r/hexojs/hexo-server?branch=master)

Server module for [Hexo].

## Installation

``` bash
$ npm install hexo-server --save
```

## Usage

``` bash
$ hexo server
```

Option | Description | Default
--- | --- | ---
`-i`, `--ip` | Override the default server IP. | `::` when IPv6 is available, else `0.0.0.0` (note: in most systems, `::` also binds to `0.0.0.0`)
`-p`, `--port` | Override the default port. | 4000
`-s`, `--static` | Only serve static files. | false
`-l`, `--log [format]` | Enable logger. Override log format. | false
`-o`, `--open` | Immediately open the server url in your default web browser. | false

## Options

``` yaml
server:
  port: 4000
  log: false
  ip: 0.0.0.0
  compress: false
  cache: false
  header: true
  serveStatic:
    extensions:
    - html
```

- **port**: Server port
- **log**: Display request info on the console. Always enabled in debug mode.
- **ip**: Server IP
- **compress**: Enable GZIP compression
- **cache**: Enable cache for rendered content
  - This can speed up server response. However, any changes will no longer take effect in real time.
  - Suitable for production environment only.
- **header**: Add `X-Powered-By: Hexo` header
- **serveStatic**: Extra options passed to [serve-static](https://github.com/expressjs/serve-static#options)

## Middleware

`hexo-server` runs the `server_middleware` filter before starting the server. Plugins and theme scripts can register [Connect] middleware with it; the filter receives the `app` instance.

For example, to add a custom response header:

``` js
hexo.extend.filter.register("server_middleware", function (app) {
  app.use(function (req, res, next) {
    res.setHeader("X-Hexo-Middleware", "enabled");
    next();
  });
});
```

[Connect]: https://github.com/senchalabs/connect

## License

MIT

[Hexo]: http://hexo.io/

hexo-server

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

hexo-server

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README