【nuxt3】robots.txtを使う

この記事の環境

    "nuxt": "^3.8.0"
    "@nuxtjs/robots": "^3.0.0"（今回の記事で導入するモジュール）

nuxtjs/robotsとは？

これです：robots - A Nuxt module thats inject a middleware to generate a robots.txt file

nuxtのモジュール一覧に掲載があるrobotsというモジュールがrobots.txtの出力を担っています。

使い方

ドキュメントを見れば比較的複雑なことも少ないような感じですが、概要をさっくり書いておきますね。

1. インストール

#どちらか好きな方
yarn add @nuxtjs/robots
npm install @nuxtjs/robots

2. nuxt.config.tsに記述

export default {
    //...（前略）
  modules: [
    ['@nuxtjs/robots', { 
      rules:{
        UserAgent: '*',
        Disallow: '/'
      }
    }]
  ],
    //...（後略）
}

これで、ビルド時に以下のようなrobots.txtが生成されます：

    User-agent: *
    Disallow: /

以上、設定は終了です！

補足

ちなみに、設定なし、あるいは設定できていない場合ではデフォルトで以下のrobots.txtが出力されます。

    User-agent: *
    Disallow:

私はrulesをキーにしていなくて、意図通りにならずに少し詰まりました。

ドキュメントの読み込みが大事ですね。

sitemap記述の例や、configファイルを用いた生成方法も公式ドキュメントに記載があるので、必要に応じてご参照ください。

再掲：robots - A Nuxt module thats inject a middleware to generate a robots.txt file