Skip to content

Instantly share code, notes, and snippets.

@valmayaki

valmayaki/aider-convention-scraper

Forked from chr15m/aider-convention-scraper
Created June 21, 2025 10:43
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save valmayaki/f5b7cb4b16b94a6e6e5d6c80abb5e49d to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save valmayaki/f5b7cb4b16b94a6e6e5d6c80abb5e49d to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @chr15m chr15m revised this gist Feb 7, 2025. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion aider-convention-scraper
    View file
    Original file line number Diff line number Diff line change
    @@ -13,4 +13,4 @@ if [ $# -eq 0 ]; then
    exit 1
    fi

    aider --detect-urls --yes --message "Please summarize the documentation at the following URL into a concise form suitable for giving an LLM context about a project. Write the summary as Markdown into a .md file with a relevant short kebab-case name like 'technology-name.md'. Where appropriate make sure you include a suite of relevant code examples to help the LLM write code in the suggested style of the project. The result will be concatenated with summaries of other technologies so it should have a clear h1 header indicating the content of this markdown section/file. $*"
    aider --detect-urls --no-git --no-auto-commits --yes --message "Please summarize the documentation at the following URL into a concise form suitable for giving an LLM context about a project. Write the summary as Markdown into a .md file with a relevant short kebab-case name like 'technology-name.md'. Where appropriate make sure you include a suite of relevant code examples to help the LLM write code in the suggested style of the project. The result will be concatenated with summaries of other technologies so it should have a clear h1 header indicating the content of this markdown section/file. $*"
  2. @chr15m chr15m renamed this gist Feb 3, 2025. 1 changed file with 0 additions and 0 deletions.
    0 aider-convention-scraper.sh → aider-convention-scraper
    View file
    File renamed without changes.
  3. @chr15m chr15m created this gist Feb 3, 2025.
    16 changes: 16 additions & 0 deletions aider-convention-scraper.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,16 @@
    #!/bin/sh

    # Scrapes documentation from a URL and converts it to Markdown suitable for aider convention files
    # to provide context to the LLM.

    if [ $# -eq 0 ]; then
    echo "Usage: $(basename "$0") <URL> [URL...]"
    echo
    echo "Generate aider 'convention' Markdown context from documentation URLs."
    echo "suitable for providing LLM context about a project's conventions and style."
    echo
    echo "Outputs a file in the current directory named like 'technology-name.md'."
    exit 1
    fi

    aider --detect-urls --yes --message "Please summarize the documentation at the following URL into a concise form suitable for giving an LLM context about a project. Write the summary as Markdown into a .md file with a relevant short kebab-case name like 'technology-name.md'. Where appropriate make sure you include a suite of relevant code examples to help the LLM write code in the suggested style of the project. The result will be concatenated with summaries of other technologies so it should have a clear h1 header indicating the content of this markdown section/file. $*"