https://github.com/expelledboy/threejs-manual-generator

Single-page Three.js documentation generator for use as docs in Cursor AI
https://github.com/expelledboy/threejs-manual-generator

cursor-ai documentation puppeteer single-page threejs web-scraping

Last synced: about 1 month ago
JSON representation

Single-page Three.js documentation generator for use as docs in Cursor AI

• Host: GitHub
• URL: https://github.com/expelledboy/threejs-manual-generator
• Owner: expelledboy
• Created: 2024-12-01T00:50:16.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-12-01T01:24:15.000Z (about 1 month ago)
• Last Synced: 2024-12-01T01:27:46.765Z (about 1 month ago)
• Topics: cursor-ai, documentation, puppeteer, single-page, threejs, web-scraping
• Language: JavaScript
• Homepage:
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Three.js Documentation Scraper

Scrapes the Three.js documentation into a single HTML file for Cursor AI integration. Preserves original styling, search functionality, and navigation.

View it at: `https://expelledboy.github.io/threejs-manual-generator`

## Quick Start

```bash

# Install

npm install

# Development (scrapes 10 pages)

npm run dev

# Production (scrapes all pages)

npm run prod

```

## Requirements

- Node.js >= 18.0.0

## Output

Generated file: `docs/index.html`

## Development

```bash

npm test          # Run tests

npm run lint      # Check code style

npm run format    # Format code

npm run clear-cache # Clear cached pages

```

## Structure

```

src/

  ├── scraper.js      # Main implementation

  └── scraper.test.js # Tests

```

## License

MIT