KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #typescript #codex #cli #claude-code #mcp #rust #deepseek-harness #ai-agent

immersive-reading

★ 45 Open GitHub ↗

Turn dense long-form ideas into immersive Reading Editions.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Immersive Reading

Turn dense long-form ideas into bespoke learning spaces that are delightful to explore.

Bring a link, essay, transcript, note, or paper. Get back a polished learning
space with chapters, source attribution, search, highlights, notes, and optional
bilingual support.

[![Start](https://img.shields.io/badge/Quick_Start-Install_now-111111?style=for-the-badge&labelColor=9A5A25)](https://raw.githubusercontent.com/ryannli/immersive-reading/main/)
[![Skill](https://img.shields.io/badge/Reusable_Skill-immersive--reading-111111?style=for-the-badge&labelColor=5B6675)](https://raw.githubusercontent.com/ryannli/immersive-reading/main/skills/immersive-reading/SKILL.md)
[![Demo](https://img.shields.io/badge/Demo-Watch_the_X_post-111111?style=for-the-badge&labelColor=B87941)](https://x.com/ranli_thinker/status/2071738620860682365)

</div>

## Not A Summary. A Co-Reading Space.

Example: Paul Graham's epic essay,
[How to Do Great Work](https://paulgraham.com/greatwork.html).

| Before | After |
| --- | --- |
| [![Before: plain essay page](https://raw.githubusercontent.com/ryannli/immersive-reading/main/docs/media/how-to-do-great-work-before.gif)](https://paulgraham.com/greatwork.html) | [![After: immersive reading space](https://raw.githubusercontent.com/ryannli/immersive-reading/main/docs/media/how-to-do-great-work-after.gif)](https://x.com/ranli_thinker/status/2071738620860682365) |
| [Open original essay](https://paulgraham.com/greatwork.html) | [Open live reading space](http://ranli.me/read-paul-graham) · [Watch the X post](https://x.com/ranli_thinker/status/2071738620860682365) |

## What It Builds

<table>
 <tr>
 <td width="33%" valign="top">
 01 · BRING 
 Source material 
 Essays, posts, transcripts, notes, papers, URLs, or local files. 
 <kbd>raw text</kbd> <kbd>link</kbd> <kbd>file</kbd>
 </td>
 <td width="33%" valign="top">
 02 · SHAPE 
 Agent-built structure 
 Chapters, section beats, anchor quotes, source media, and optional study language. 
 <kbd>chapters</kbd> <kbd>quotes</kbd> <kbd>media</kbd>
 </td>
 <td width="33%" valign="top">
 03 · OPEN 
 Interactive learning space 
 A static reader with search, highlights, notes, attribution, and theme support. 
 <kbd>search</kbd> <kbd>highlights</kbd> <kbd>notes</kbd>
 </td>
 </tr>
</table>

<table>
 <tr>
 <td width="33%" valign="top">
 READING FLOW 
 Turn dense text into a path. 
 Chapter openings, section beats, anchor quotes, and scroll-driven transitions.
 </td>
 <td width="33%" valign="top">
 STUDY SURFACE 
 Make the source usable. 
 Search, highlights, notes, copyable notes, optional bilingual support, and light/dark mode.
 </td>
 <td width="33%" valign="top">
 REUSABLE SCAFFOLD 
 Ship the same quality again. 
 Validated article data, source media, and static output ready for local use or Vercel.
 </td>
 </tr>
</table>

## Quick Start

<details open>
<summary>Claude Code</summary>

Install and run it as a Claude Code plugin. Send these as four separate
Claude Code messages:

```text
/plugin marketplace add ryannli/immersive-reading
```

```text
/plugin install immersive-reading@immersive-reading
```

```text
/reload-plugins
```

```text
/immersive-reading:immersive-reading
```

Then paste any essay, post, transcript, note, paper, URL, or local file you
want to turn into a learning space.

Or install it as an open agent skill:

```bash
npx skills add ryannli/immersive-reading
```

Choose Claude Code if the installer asks. Then start a new Claude Code session
and ask for `immersive-reading`.

No-prompt install:

```bash
npx skills add ryannli/immersive-reading -g -a claude-code -y
```

</details>

<details>
<summary>Codex</summary>

Install the skill into your local Codex skills folder:

```bash
npx skills add ryannli/immersive-reading
```

Choose Codex if the installer asks. Then start a new Codex session and use:

```text
Use $immersive-reading on this article:
https://paulgraham.com/greatwork.html
```

</details>

<details>
<summary>Cursor</summary>

Install the skill into Cursor:

```bash
npx skills add ryannli/immersive-reading
```

Choose Cursor if the installer asks.

</details>

<details>
<summary>Antigravity CLI</summary>

```bash
agy plugin install https://github.com/ryannli/immersive-reading.git
```

</details>

<details>
<summary>Other SKILL.md-compatible agents</summary>

The Skills CLI can install this repo into supported coding agents. It fetches
the `skills/immersive-reading` folder directly from GitHub; this repo does not
need to be published as an npm package.

Replace `codex` with your agent name:

```bash
npx skills add ryannli/immersive-reading -g -a codex -y
```

</details>

## Start With Anything

```text
Use $immersive-reading on this article:
https://paulgraham.com/greatwork.html
```

For bilingual reading:

```text
Use $immersive-reading on this link and add Spanish bilingual mode:
https://paulgraham.com/greatwork.html
```

You can also paste text or point to a local file. The agent chooses where to
create the site and tells you when it is ready.

## License

MIT.

immersive-reading

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README