{"id":22110749,"url":"https://github.com/expelledboy/threejs-manual-generator","last_synced_at":"2026-05-08T13:19:19.211Z","repository":{"id":265800324,"uuid":"896663111","full_name":"expelledboy/threejs-manual-generator","owner":"expelledboy","description":"Single-page Three.js documentation generator for use as docs in Cursor AI","archived":false,"fork":false,"pushed_at":"2024-12-01T12:54:12.000Z","size":439,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-06T02:04:14.463Z","etag":null,"topics":["cursor-ai","documentation","puppeteer","single-page","threejs","web-scraping"],"latest_commit_sha":null,"homepage":"https://expelledboy.github.io/threejs-manual-generator/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/expelledboy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-01T00:50:16.000Z","updated_at":"2025-03-18T10:02:02.000Z","dependencies_parsed_at":"2024-12-03T09:16:09.868Z","dependency_job_id":null,"html_url":"https://github.com/expelledboy/threejs-manual-generator","commit_stats":null,"previous_names":["expelledboy/react-three-manual-generator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/expelledboy/threejs-manual-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expelledboy%2Fthreejs-manual-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expelledboy%2Fthreejs-manual-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expelledboy%2Fthreejs-manual-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expelledboy%2Fthreejs-manual-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/expelledboy","download_url":"https://codeload.github.com/expelledboy/threejs-manual-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expelledboy%2Fthreejs-manual-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32781992,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"ssl_error","status_checked_at":"2026-05-08T08:22:45.650Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cursor-ai","documentation","puppeteer","single-page","threejs","web-scraping"],"created_at":"2024-12-01T10:23:04.507Z","updated_at":"2026-05-08T13:19:19.183Z","avatar_url":"https://github.com/expelledboy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Three.js Manual Generator\n\nA tool to scrape and generate a single-page, offline-friendly version of the Three.js documentation manual.\n\nView github pages [here](https://expelledboy.github.io/threejs-manual-generator/)\n\n## Features\n\n- Scrapes the entire Three.js documentation\n- Preserves original styling and formatting\n- Maintains code syntax highlighting\n- Supports offline viewing\n- Rate-limited requests to avoid server strain\n- Caching system for faster development\n- Development mode for quick testing\n\n## Prerequisites\n\nThis project uses [Nix](https://nixos.org/) for development environment management. You'll need:\n\n- Nix with flakes enabled\n- `direnv` (optional, but recommended)\n\n## Setup\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/yourusername/threejs-manual-generator.git\n   cd threejs-manual-generator\n   ```\n\n2. Enable direnv (optional):\n\n   ```bash\n   direnv allow # sources .envrc\n   ```\n\n3. Install dependencies:\n   ```bash\n   npm install\n   ```\n\n## Usage\n\n### Development Mode\n\nRun with a limit of 10 pages for testing:\n\n```bash\nnpm run dev\n```\n\n### Production Mode\n\nGenerate the complete documentation:\n\n```bash\nnpm run prod\n```\n\n### Publishing\n\nTo build and publish to the docs branch:\n\n```bash\njust publish\n```\n\nThis will:\n\n1. Build the documentation\n2. Update the LAST_UPDATED timestamp\n3. Commit changes to the docs branch\n4. Reset the working directory\n\n### Other Commands\n\n- `npm run lint` - Check code style\n- `npm run lint:fix` - Fix code style issues\n- `npm run format` - Format code\n- `npm run test` - Run tests\n- `npm run clear-cache` - Clear the cache\n\n## Development\n\nThe project uses:\n\n- Node.js 18\n- Puppeteer for web scraping\n- Jest for testing\n- ESLint and Prettier for code style\n- Just for task running\n\n### Cache System\n\nThe scraper caches downloaded pages to speed up development. To clear the cache:\n\n```bash\nnpm run clear-cache\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexpelledboy%2Fthreejs-manual-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexpelledboy%2Fthreejs-manual-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexpelledboy%2Fthreejs-manual-generator/lists"}