Skip to content

Commit

Permalink
docs(@dpc-sdp/nuxt-ripple): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
David Featherston committed Jun 25, 2023
1 parent 939d97a commit 0a4c7db
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions packages/nuxt-ripple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,30 @@ They can also be set as uppercase environment variables starting with `NUXT_` an
NUXT_PUBLIC_TIDE_SITE=8888
NUXT_PUBLIC_TIDE_BASE_URL=https://develop.content.reference.sdp.vic.gov.au
```

### Robots.txt

The robots.txt file is handled automatically by `@dpc-sdp/nuxt-ripple`, but can be overridden and extended via the `nuxt.config` if needed.

```js
import { createResolver } from '@nuxt/kit'
const { resolve } = createResolver(import.meta.url)

export default defineNuxtConfig({
robots: {
configPath: resolve('./robots.config.ts')
}
})
```
```js
import rules from '@dpc-sdp/nuxt-ripple/robots'

export default [
// optionally include, filter or map the default rules
...rules,

// add addtional rules
{ UserAgent: 'SomeCustomBot', Disallow: '/' }
]
```

0 comments on commit 0a4c7db

Please sign in to comment.