llms-txt-action 0.1.0rc5

GitHub Action to make documentation more accessible to LLMs.

LLM-TXT-ACTION

Convert documentation websites into LLM-ready text files. Perfect for training or fine-tuning language models on your documentation. For more details read: https://llmstxt.org/

Features

• 📄 Content Processing: Generate LLM-ready text files from popular document frameworks such as MKDocs, Sphinx and more.
• 💾 Multiple Output Formats: Save content in HTML, Markdown, and metadata formats

Quick Start

Add this to your GitHub workflow:

    steps:
      - name: Generate llms.txt
        uses: demodrive-ai/llm-txt-action@v0.1.0
        with:
          generate_md_files: true
          # any other inputs you would like to set.

Input Parameters

Parameter	Required	Default	Description
docs_dir	No	site/	Documentation output directory
generate_llms_txt	No	true	Whether to generate LLMS.txt file
generate_llms_full_txt	No	true	Whether to generate llms_full.txt file
generate_md_files	No	true	Generate md files for each html file
llms_txt_name	No	llms.txt	Name of the llms.txt output file
llms_full_txt_name	No	llms_full.txt	Name of the llms_full.txt output file
poetry_version	No	latest	Poetry version to use (or 'latest')
push_to_git	No	false	Whether to push generated files to git
push_to_artifacts	No	false	Whether to push generated files to artifacts

Local Development

1. Clone and install:

   # clone the repo
   poetry install
   

2. Run the crawler:

   poetry run python src/llms_txt_action/main.py --docs-dir site/
   

Examples

1. Deploy MkDocs website to Github Pages.

      - name: Generate static files
        run : mkdocs build

      - name: Generate llms.txt, md files.
        uses: demodrive-ai/llm-txt-action@v0.1.0
        with:
          generate_md_files: true

      - name: Deploy to Github
        run : mkdocs gh-deploy --dirty

License

This project is licensed under the MIT License - see the LICENSE file for details.