# kerouac-robotstxt

> robots.txt middleware for Kerouac.

Latest version **0.7.0** (published 2024-03-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install kerouac-robotstxt
pnpm add kerouac-robotstxt
yarn add kerouac-robotstxt
bun add kerouac-robotstxt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.0 |
| Published | 2024-03-11 |
| First published | 2013-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.6.0 |
| Dependencies | 1 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jared Hanson |
| Maintainers | jaredhanson |
| Keywords | robots, robots.txt, sitemap, sitemaps |

## Links

- npm: https://www.npmjs.com/package/kerouac-robotstxt
- Repository: https://github.com/jaredhanson/kerouac-robotstxt
- Homepage: https://github.com/jaredhanson/kerouac-robotstxt#readme
- Issues: https://github.com/jaredhanson/kerouac-robotstxt/issues
- Funding: https://github.com/sponsors/jaredhanson
- npm.io page: https://npm.io/package/kerouac-robotstxt

## Dependencies (1)

- [kerouac](https://npm.io/package/kerouac.md) ^0.3.0

## Recent versions

- 0.7.0 (latest) — 2024-03-11
- 0.6.0 — 2024-02-20
- 0.5.0 — 2023-12-14
- 0.4.2 — 2018-09-12
- 0.4.1 — 2018-09-12
- 0.4.0 — 2017-10-07
- 0.3.0 — 2017-10-07
- 0.2.0 — 2017-10-05
- 0.1.0 — 2013-05-02

## README

# kerouac-robotstxt

[Kerouac](https://github.com/jaredhanson/kerouac) middleware that gives
instructions to web crawlers using the [Robots Exclusion Protocol](https://www.robotstxt.org/).

## Install

```sh
$ npm install kerouac-robotstxt
```

## Usage

Declare a `robots.txt` route, using this middleware.

```js
var robots = require('kerouac-robotstxt');

site.page('/robots.txt', robots());
```

And map a `robots.txt` file when generating the site.

```js
site.generate([
  robots.createMapper()
]);
```

The generated output will include a `/robots.txt` file.  If your site contains
any sitemaps, which can be generated using [kerouac-sitemap](https://github.com/jaredhanson/kerouac-sitemap),
the locations of those sitemaps will be included so that search engines can
automatically discover all pages of your site.

## License

[The MIT License](http://opensource.org/licenses/MIT)

Copyright (c) 2012-2022 Jared Hanson <[https://www.jaredhanson.me/](https://www.jaredhanson.me/)>

---
_Source: https://npm.io/package/kerouac-robotstxt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._