Skip to content

Latest commit

 

History

14 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

scrape-docs

Centralized, scheduled documentation scraping for a collection of public Markdown repositories.

The scraper runs every 5 minutes on GitHub Actions and publishes each docset to mpsuesser/scraped-docs-<name>. Downstream repositories contain only the generated documentation and can be used directly as OpenCode references.

// opencode.jsonc

{
  // ...
  "references": {
    "foldkit-docs": {
      "repository": "mpsuesser/scraped-docs-foldkit",
      "branch": "main",
      "description": "Full scraped documentation for Foldkit"
    },
    "alchemy-docs": {
      "repository": "mpsuesser/scraped-docs-alchemy",
      "branch": "main",
      "description": "Full scraped documentation for Alchemy"
    }
  }
}

Docsets

Commands

bun install
bun run typecheck
bun run test
bun run scrape-docs:foldkit
bun run alchemy:plan

Alchemy declares the downstream repositories in alchemy.run.ts. The workflow uses repository-scoped SSH deploy keys stored in the encrypted DOCS_REPO_KEYS Actions secret.

About

Scheduled scrapers for publishing always-up-to-date documentation repos which can be referenced directly in OpenCode v2 configs

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages