astro-llms-txt v0.0.1-beta

🚀 Astro LLMS TXT (WIP)

LlmsTXT generates a /llms.txt file to guide LLMs in utilizing your website at inference time.

Note:

This integration is still a work in progress! As we iron out the kinks, We'll let you know when it's ready for prime time.

📦 Installation

⚡ Quick Install

the astro add command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren’t sure which package manager you’re using, run the first command.) Then, follow the prompts, and type “y” in the terminal (meaning “yes”) for each one.

Install using pnpm:

pnpm astro add astro-llms-txt

Or using npm:

npx astro add astro-llms-txt

Or using yarn:

yarn astro add astro-llms-txt

🔧 Manual Install

First, install the astro-llms-txt package using your package manager. (If you aren’t sure which package manager you’re using, run the first command.)

Using PNPM

pnpm install astro-llms-txt

Using NPM

npm install astro-llms-txt

Using Yarn

yarn add astro-llms-txt

Then, apply this integration to your astro.config.mjs file using the integrations property:

import LlmsTXT from 'astro-llms-txt';

export default {
  // ...
  integrations: [LlmsTXT()]
};

🥑 Usage

When you install this integration, things will be auto-wired for you, and a llms.txt file will be automatically generated at the root of your website after the build.

⚙️ Configuration

LlmsTXT has a list of options that allow you to customize its behavior. And this Astro integration allow you to pass those options easily in your astro.config.mjs file:

export default defineConfig({
  integrations: [LlmsTXT({})]
});

📖 Available Options

Here is a list of options, that are allowed to be passed in the config:

export type LlmsTXTOptions = {};

📝 Changelog

Please see the Changelog for more information on what has changed recently.

💝 Acknowledgements

• LlmsTXT