{"library":"mkdocs-llmstxt","title":"MkDocs LLMstxt Plugin","description":"MkDocs plugin to generate an `/llms.txt` file, a standard for providing LLM-friendly content summaries and links from websites. It automatically processes your MkDocs documentation during the build process, creating a concise index of content accessible to AI language models. The plugin can also generate a `/llms-full.txt` file with concatenated content and per-page Markdown files. The project is currently in maintenance mode.","language":"python","status":"maintenance","last_verified":"Thu Apr 16","install":{"commands":["pip install mkdocs-llmstxt"],"cli":null},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"mkdir my-llm-docs\ncd my-llm-docs\n\n# Create a minimal MkDocs config\ncat <<EOF > mkdocs.yml\nsite_name: My LLM Project\nsite_url: https://example.com/ # REQUIRED for llmstxt plugin\nsite_description: A concise description of my project for LLMs.\nplugins:\n  - llmstxt:\n      markdown_description: >\n        This is a longer, more detailed description of the project.\n        It provides additional context for AI models.\n      sections:\n        Introduction:\n          - index.md: Key concepts and overview\n        Guides:\n          - guides/*.md # Glob patterns are supported\n        API Reference:\n          - api/reference.md\nEOF\n\n# Create some example documentation files\nmkdir docs docs/guides docs/api\ncat <<EOF > docs/index.md\n# Welcome to My LLM Project\n\nThis is the main introduction to our project.\nEOF\n\ncat <<EOF > docs/guides/setup.md\n# Setup Guide\n\nFollow these steps to set up the project.\nEOF\n\ncat <<EOF > docs/api/reference.md\n# API Reference\n\nDetails about the API endpoints.\nEOF\n\n# Build the documentation, which generates llms.txt\nmkdocs build\n\necho \"\\nCheck the 'site' directory for llms.txt and the generated Markdown files.\"\n# To serve locally:\n# mkdocs serve","lang":"bash","description":"This quickstart guides you through setting up a new MkDocs project, configuring the `mkdocs-llmstxt` plugin, creating some sample documentation, and building the site to generate the `/llms.txt` file. The `site_url` configuration option is crucial for correct link generation. After building, `llms.txt` will be available in your `site` directory, along with Markdown versions of your pages if configured.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}