{"id":50823278,"url":"https://github.com/uptick/linear-walkthrough","last_synced_at":"2026-06-13T16:10:49.546Z","repository":{"id":342255082,"uuid":"1173344379","full_name":"uptick/linear-walkthrough","owner":"uptick","description":"A claude code friendly cli tool to visualize markdowns for the purpose of linear code walkthroughs","archived":false,"fork":false,"pushed_at":"2026-03-12T03:02:47.000Z","size":372,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-07T12:07:28.346Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uptick.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-05T09:07:47.000Z","updated_at":"2026-03-12T03:02:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/uptick/linear-walkthrough","commit_stats":null,"previous_names":["uptick/linear-walkthrough"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/uptick/linear-walkthrough","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Flinear-walkthrough","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Flinear-walkthrough/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Flinear-walkthrough/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Flinear-walkthrough/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uptick","download_url":"https://codeload.github.com/uptick/linear-walkthrough/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Flinear-walkthrough/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34290605,"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-06-13T02:00:06.617Z","response_time":62,"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-06-13T16:10:47.806Z","updated_at":"2026-06-13T16:10:49.540Z","avatar_url":"https://github.com/uptick.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# linear-walkthrough\n\nGenerate self-contained, GitHub-styled HTML walkthroughs from GFM markdown.\n\nTakes markdown files with code walkthroughs and produces single-file HTML pages with syntax highlighting, dark mode support, and Mermaid diagram rendering. Optionally launches an interactive server where you can select text and ask Claude follow-up questions.\n\n![Screenshot of linear-walkthrough interactive mode](screenshot.png)\n\n## Install\n\n```bash\n# Run directly from GitHub\nuvx --from git+https://github.com/uptick/linear-walkthrough linear-walkthrough input.md -o output.html\n\n# Or install locally\nuv pip install git+https://github.com/uptick/linear-walkthrough\nlinear-walkthrough input.md -o output.html\n```\n\n## AI Coding Assistants\n\nAdd the skill to your AI coding assistant:\n\n```bash\nnpx skills add uptick/linear-walkthrough\n```\n\nWorks with Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Goose, OpenCode, and Windsurf.\n\nExample prompts:\n\n```\n/linear-walkthrough Walk me through the auth module\n/linear-walkthrough Create a walkthrough for PR #42\n/linear-walkthrough Give me a beginner-friendly walkthrough of the API layer\n```\n\n## Quick Start\n\n```bash\n# File input → file output\nuv run linear-walkthrough input.md -o output.html\n\n# Stdin → stdout\ncat input.md | uv run linear-walkthrough -o out.html\n\n# Interactive server mode (opens browser)\nuv run linear-walkthrough input.md --serve\n```\n\n## Features\n\n- **GFM markdown** — tables, task lists, fenced code blocks\n- **Syntax highlighting** — Pygments with light/dark theme support via `prefers-color-scheme`\n- **Mermaid diagrams** — rendered client-side from fenced `mermaid` blocks\n- **Self-contained output** — single HTML file with all CSS inlined\n- **Interactive mode** — select text in the browser, ask Claude follow-up questions, responses appended to the source file\n\n## Interactive Server Mode\n\n```bash\nuv run linear-walkthrough walkthrough.md --serve [-p PORT] [--cwd DIR]\n```\n\nStarts a local HTTP server (default port 7847) that renders your walkthrough with a text selection UI. Select any text and ask a question — Claude responds using the full walkthrough as context. Follow-up responses are appended to the original markdown file.\n\n## Project Structure\n\n```\nlinear_walkthrough/\n  cli.py           - CLI entry point\n  renderer.py      - Markdown → HTML via markdown-it-py + Pygments\n  template.py      - Minijinja template loader + CSS\n  server.py        - Interactive server mode (stdlib http.server + claude subprocess)\n  templates/\n    page.html              - Static output template\n    page_interactive.html  - Interactive template with follow-up JS\n```\n\n## Tech Stack\n\n- **Python 3.12+** managed with **uv**\n- **markdown-it-py** — GFM parsing\n- **Pygments** — syntax highlighting\n- **minijinja** — HTML templating\n- **Mermaid.js** — diagram rendering (CDN)\n\n## Development\n\n```bash\nuv run ruff check .    # lint\nuv run mypy .          # type check\nuv run pytest          # test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptick%2Flinear-walkthrough","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuptick%2Flinear-walkthrough","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptick%2Flinear-walkthrough/lists"}