{"id":51464706,"url":"https://github.com/simplearyan/iitm-notes-archive","last_synced_at":"2026-07-06T09:31:54.920Z","repository":{"id":349088984,"uuid":"1200975652","full_name":"simplearyan/iitm-notes-archive","owner":"simplearyan","description":"IITM Notes Archive | This is an unofficial, personal organization tool. It is not affiliated with, endorsed by, or sponsored by the Indian Institute of Technology Madras (IITM).","archived":false,"fork":false,"pushed_at":"2026-06-28T02:42:46.000Z","size":338648,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-28T04:23:40.868Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://simplearyan.github.io/iitm-notes-archive/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simplearyan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-04T03:47:43.000Z","updated_at":"2026-04-30T03:50:45.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/simplearyan/iitm-notes-archive","commit_stats":null,"previous_names":["simplearyan/iitm-notes-archive"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/simplearyan/iitm-notes-archive","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplearyan%2Fiitm-notes-archive","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplearyan%2Fiitm-notes-archive/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplearyan%2Fiitm-notes-archive/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplearyan%2Fiitm-notes-archive/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplearyan","download_url":"https://codeload.github.com/simplearyan/iitm-notes-archive/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplearyan%2Fiitm-notes-archive/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35185688,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-06T02:00:07.184Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2026-07-06T09:31:54.231Z","updated_at":"2026-07-06T09:31:54.912Z","avatar_url":"https://github.com/simplearyan.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎓 IITM Notes Archive: The High-Performance Course Hub\n\n![Lighthouse Score](https://img.shields.io/badge/Lighthouse-100-brightgreen)\n![License](https://img.shields.io/badge/License-MIT-blue)\n\nA premium, data-driven digital archive for the **IITM Data Science Degree**. Built for speed, offline reliability, and effortless navigation.\n\n## 🚀 The Vision\nTired of slow, clunky course viewers and searching through endless folders of saved pages? This project transforms your static **SingleFileZ** (`.u.zip.html`) saves into a lightning-fast, interactive Single Page Application.\n\n\u003e [!TIP]\n\u003e This archive is optimized for 0ms render delay by pre-compiling all styles and unzipping course payloads on the fly during deployment.\n\n---\n\n## ✨ Key Features\n\n- ⚡ **Instant Load Times:** Swapped the Tailwind Play CDN for a statically compiled `main.css`, cutting boatloads of render-blocking time.\n- 📂 **Auto-Generated Sidebar:** A smart Node.js engine recursively crawls your `content/` folder to build a beautiful, nested navigation tree.\n- 🌓 **Modern Aesthetics:** A sleek, dark-themed dashboard with glassmorphism effects and dynamic course filtering.\n- 📱 **Mobile First:** Fully responsive UI with a custom off-canvas navigation drawer and touch-optimized controls.\n- 🛠️ **Automated CI/CD:** Powered by GitHub Actions. Just push your files, and the system automatically unzips, optimizes, and deploys.\n\n---\n\n## 🏗️ System Architecture\n\n### 1. The Core (index.html)\nA lightweight SPA using **Vanilla JS** for routing and **Tailwind CSS** for styling. It uses hash-based routing (`#dashboard`, `#file-path`) to maintain state without page reloads.\n\n### 2. The Optimizer (Node.js)\n- `scripts/optimize-for-prod.js`: Uses `7z` to extract high-density polyglot ZIP/HTML files into streamable directory structures.\n- `scripts/generate-sidebar.js`: Generates a real-time JSON map of your entire course library.\n\n### 3. The Pipeline (GitHub Actions)\nOur custom `.github/workflows/deploy.yml` handles:\n1. **Environment Setup:** Installs Node.js and specialized extraction tools (`7z`).\n2. **Optimization Pass:** Unpacks all new SingleFileZ archives.\n3. **Data Refresh:** Rebuilds the sidebar JSON map.\n4. **Style Build:** Compiles the final production CSS.\n5. **Direct Deploy:** Pushes the artifact directly to the GitHub Pages edge network.\n\n---\n\n## 🛠️ Getting Started: The \"Drag \u0026 Drop\" Workflow\n\n1. **Capture Content:** Use the [SingleFileZ](https://github.com/gildas-lormeau/SingleFileZ) extension to save your course pages.\n2. **Organize:** Drop your `.html` files into the `content/` folder. Use any nested structure you like (e.g., `Term/Course/Week/`).\n3. **Push \u0026 Deploy:**\n   ```bash\n   git add .\n   git commit -m \"feat: add new course modules\"\n   git push origin main\n   ```\n4. **Sit Back:** Your GitHub Action will trigger, optimize your files, and update your live site in ~2 minutes.\n\n---\n\n## 🖨️ Automated PDF Conversion\n\nThis project includes a built-in PDF factory to turn your course modules into printable handouts.\n\n### 🚀 Standard vs. ✨ v3 Ultra vs. 📐 v4 Compact\n- **Standard:** Quick batch conversion of every file in a course directory.\n- **v3 Ultra:** High-fidelity multi-page rendering. Supports long assignments with full layout unrolling.\n- **v4 Compact:** Academic-grade efficiency. Removes UI clutter, fixes KaTeX math doubling, and optimizes spacing for printable handouts.\n\n### 💻 Local Usage\n```bash\n# Generate Standard PDFs\nnpm run pdf\n\n# Generate v3 Ultra PDFs\nnpm run v3-pdf\n\n# Generate v4 Compact PDFs (Recommended for Handouts)\nnpm run v4-pdf\n```\n\n### ☁️ GitHub Actions Usage\nYou can trigger these manually from the **Actions** tab:\n1. Select **📄 Standard Course PDF Generator 🛠️**, **🚀 v3 Ultra-High Quality PDF Generator ✨**, or **📐 v4 Compact Efficiency PDF Generator 📐**.\n2. Click **Run workflow** and specify the course/week.\n3. Download the PDFs from the workflow summary or find them in the `gh-pages` branch inside their respective folders (`v3-pdf/` or `v4-pdf/`).\n\n### 🏰 Backup Vault\nA complete mirror of all raw assets, optimized modules, and PDF versions is maintained on the `backup-vault` branch. This is synchronized weekly or can be triggered manually via the **🏰 Multi-Content Sync \u0026 Backup 🛡️** action.\n\n---\n\n## 📚 Markdown Archive Module\n\nA dedicated markdown documentation site with full-text search, sidebar navigation, and responsive design. Perfect for study notes and organized course materials.\n\n### 🎯 Features\n- **Auto-Extraction:** Converts course HTML archives to clean markdown\n- **Full-Text Search:** Client-side search with Lunr.js\n- **Dual Sources:** Auto-extracted markdown + hand-written study notes\n- **Math Support:** KaTeX for LaTeX equations\n- **Code Highlighting:** Prism.js syntax highlighting\n- **Mobile Responsive:** Touch-friendly off-canvas navigation\n\n### 🚀 Quick Start\n```bash\n# Extract markdown from archives\nnpm run markdown:extract\n\n# Generate search index\nnpm run markdown:index\n\n# View locally\nopen markdown/index.html\n```\n\n### 📁 Structure\n```\nmarkdown/\n├── extracted/    ← Auto-extracted from course archives\n├── manual/       ← Hand-written study notes\n└── index.html    ← Responsive SPA\n```\n\n### 📖 Documentation\nSee [`markdown/README.md`](markdown/README.md) for complete guide or [`markdown/manual/GETTING_STARTED.md`](markdown/manual/GETTING_STARTED.md) for user guide.\n\n### 🔗 Live Site\n- **Markdown Archive:** https://simplearyan.github.io/iitm-notes-archive/markdown/\n- **Main Archive:** https://simplearyan.github.io/iitm-notes-archive/\n\n---\n\n## ⚖️ Disclaimer\n\nThis is an **unofficial, personal organization tool**. It is not affiliated with, endorsed by, or sponsored by the **Indian Institute of Technology Madras (IITM)**.\n\nAll course materials, questions, syllabus content, and related intellectual property belong exclusively to **IITM** and the respective instructors. This tool is designed purely for personal offline study and productivity purposes.\n\n---\n\n\u003cp align=\"center\"\u003eMade with ❤️ for the IITM BS community.\u003c/p\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplearyan%2Fiitm-notes-archive","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplearyan%2Fiitm-notes-archive","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplearyan%2Fiitm-notes-archive/lists"}