Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuyk/honkit-plugin-robots
Generate a robots.txt for your Honkit Documentation.
https://github.com/stuyk/honkit-plugin-robots
Last synced: 18 days ago
JSON representation
Generate a robots.txt for your Honkit Documentation.
- Host: GitHub
- URL: https://github.com/stuyk/honkit-plugin-robots
- Owner: Stuyk
- Created: 2021-03-16T00:52:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-16T01:06:06.000Z (almost 4 years ago)
- Last Synced: 2024-11-21T20:11:49.555Z (about 2 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Robots.txt Creator for Honkit
Generate a `robots.txt` for your Honkit Documentation. The output sitemap file is `robots.txt` and copied automatically.
## Install
```sh
npm install honkit-plugin-robots --save-dev
```## Usage
Add it to your `book.json` with a basic configuration:
```json
{
"plugins": ["honkit-plugin-robots"],
"pluginsConfig": {
"robots": {
"data": ["User-agent: *", "Disallow:"]
}
}
}
```