Merge pull request #2749 from TiberiusNemesis/docs/tanstack-query-router

feat(tanstack): add TanStack Query and TanStack Router documentation

Author: simon04

assets/javascripts/news.json

@@ -1,4 +1,8 @@
 [
+  [
+    "2026-10-09",
+    "New documentations: <a href=\"/tanstack_query/\">TanStack Query</a>, <a href=\"/tanstack_router/\">TanStack Router</a>"
+  ],
   [
     "2026-09-04",
     "New documentation: <a href=\"/valibot/\">Valibot</a>"

lib/docs/filters/tanstack/clean_html.rb

@@ -0,0 +1,64 @@
+module Docs
+  class Tanstack
+    class CleanHtmlFilter < Filter
+      LANGUAGES = {
+        'tsx' => 'jsx',
+        'ts' => 'typescript',
+        'js' => 'javascript',
+        'shell' => 'bash',
+        'sh' => 'bash',
+        'zsh' => 'bash'
+      }
+
+      def call
+        title = at_css('h1')
+        @doc = at_css('.prose')
+        doc.prepend_child(title)
+
+        css('.anchor-heading-link', 'button').remove
+
+        css('.codeblock').each do |node|
+          pre = node.at_css('pre')
+          label = node.at_css('> div:first-child > div').try(:content).try(:strip)
+          if label.present? && label != pre['data-language']
+            node.before(%(<div class="_pre-heading">#{CGI.escapeHTML(label)}</div>))
+          end
+          node.replace(pre)
+        end
+
+        css('pre').each do |node|
+          node.content = node.content
+          node.remove_attribute('class')
+          node['data-language'] = LANGUAGES[node['data-language']] if LANGUAGES.key?(node['data-language'])
+        end
+
+        css('span.border.rounded[class~="bg-gray-500/10"]').each do |node|
+          node.name = 'code'
+          node.remove_attribute('class')
+        end
+
+        css('.markdown-alert').each do |node|
+          node['class'] = '_note'
+          node.at_css('.markdown-alert-title').try(:name=, 'strong')
+        end
+
+        css('input[type="checkbox"]').each do |node|
+          node.replace(node['checked'] ? '☑' : '☐')
+        end
+
+        # Strip Tailwind classes and tab widget attributes, then unwrap the bare layout divs
+        css('*').each do |node|
+          node.remove_attribute('class') unless node['class'].try(:start_with?, '_')
+          node.remove_attribute('id') if node['id'].try(:start_with?, ':')
+          node.attributes.each_key { |name| node.remove_attribute(name) if name.start_with?('aria-', 'data-tab', 'data-content') || name == 'role' }
+        end
+
+        css('div:not([class])').each do |node|
+          node.replace(node.children)
+        end
+
+        doc
+      end
+    end
+  end
+end

lib/docs/filters/tanstack/entries.rb

@@ -0,0 +1,71 @@
+module Docs
+  class Tanstack
+    class EntriesFilter < Docs::EntriesFilter
+      TYPES_BY_PREFIX = {
+        'reference/functions/' => 'Functions',
+        'reference/classes/' => 'Classes',
+        'reference/interfaces/' => 'Interfaces',
+        'reference/type-aliases/' => 'Type Aliases',
+        'reference/variables/' => 'Variables',
+        'guides/' => 'Guides',
+        'guide/' => 'Guides',
+        'plugins/' => 'Plugins',
+        'installation/' => 'Installation',
+        'routing/' => 'Routing',
+        'integrations/' => 'Integrations',
+        'how-to/' => 'How-to',
+        'eslint/' => 'ESLint'
+      }
+
+      # Router symbol pages are titled "useNavigate hook", "Link component", etc.
+      SYMBOL_TYPES = {
+        'hook' => 'Hooks',
+        'function' => 'Functions',
+        'component' => 'Components',
+        'type' => 'Types',
+        'class' => 'Classes',
+        'interface' => 'Interfaces'
+      }
+
+      GETTING_STARTED = %w(installation quick-start devtools faq comparison decisions-on-dx typescript graphql react-native)
+
+      def get_name
+        return 'API Reference' if page_path == 'reference/index'
+        name = heading_text(at_css('h1'))
+        symbol_type ? name.sub(/\s+\S+\z/, '') : name
+      end
+
+      def get_type
+        return 'API Reference' if page_path == 'reference/index'
+        return symbol_type || 'API' if page_path.start_with?('api/')
+        TYPES_BY_PREFIX.each { |prefix, type| return type if page_path.start_with?(prefix) }
+        GETTING_STARTED.include?(page_path) ? 'Getting Started' : 'Other'
+      end
+
+      def additional_entries
+        return [] unless page_path.start_with?('guides/', 'guide/')
+
+        css('.prose h2[id]').each_with_object([]) do |node, entries|
+          text = heading_text(node)
+          entries << ["#{name}: #{text}", node['id']] unless text.empty? || text.casecmp?('Further Reading')
+        end
+      end
+
+      private
+
+      def page_path
+        @page_path ||= slug.remove(%r{\Aframework/react/})
+      end
+
+      def symbol_type
+        return unless page_path.start_with?('api/router/')
+        words = heading_text(at_css('h1')).split
+        SYMBOL_TYPES[words.last.downcase] if words.length > 1
+      end
+
+      def heading_text(node)
+        node.content.remove('#').squish
+      end
+    end
+  end
+end

lib/docs/scrapers/tanstack.rb

@@ -0,0 +1,20 @@
+module Docs
+  class Tanstack < UrlScraper
+    self.abstract = true
+    self.type = 'simple'
+
+    html_filters.push 'tanstack/entries', 'tanstack/clean_html'
+
+    options[:attribution] = <<-HTML
+      &copy; 2021-present Tanner Linsley<br>
+      Licensed under the MIT License.
+    HTML
+
+    private
+
+    # tanstack.com sometimes stalls a connection, which hangs the crawl without a timeout
+    def request_options
+      super.merge(timeout: 60, connecttimeout: 15)
+    end
+  end
+end

lib/docs/scrapers/tanstack_query.rb

@@ -0,0 +1,22 @@
+module Docs
+  class TanstackQuery < Tanstack
+    self.name = 'TanStack Query'
+    self.slug = 'tanstack_query'
+    self.release = '5.104.1'
+    self.base_url = 'https://tanstack.com/query/latest/docs/'
+    self.root_path = 'framework/react/overview'
+    self.initial_paths = %w(eslint/eslint-plugin-query)
+    self.links = {
+      home: 'https://tanstack.com/query',
+      code: 'https://github.com/TanStack/query'
+    }
+
+    # React only, the other adapters duplicate the same pages
+    options[:only_patterns] = [/\Aframework\/react\//, /\Aeslint\//]
+    options[:skip_patterns] = [/\.md\z/, /examples/]
+
+    def get_latest_version(opts)
+      get_npm_version('@tanstack/react-query', opts)
+    end
+  end
+end

lib/docs/scrapers/tanstack_router.rb

@@ -0,0 +1,19 @@
+module Docs
+  class TanstackRouter < Tanstack
+    self.name = 'TanStack Router'
+    self.slug = 'tanstack_router'
+    self.release = '1.170.41'
+    self.base_url = 'https://tanstack.com/router/latest/docs/'
+    self.root_path = 'overview'
+    self.links = {
+      home: 'https://tanstack.com/router',
+      code: 'https://github.com/TanStack/router'
+    }
+
+    options[:skip_patterns] = [/\.md\z/, /examples/, /framework\/solid/]
+
+    def get_latest_version(opts)
+      get_npm_version('@tanstack/react-router', opts)
+    end
+  end
+end

public/icons/docs/tanstack_query/16.png

@@ -0,0 +1 @@
+https://tanstack.com/favicon-light.svg