obsidian-md-reader

KO | EN

gitlite — search

#large-language-models #llm #cloud-native #golang #chatbot #macos #codex #python #chatgpt #javascript

obsidian-md-reader

(★ 9)

No description available.

File Explorer

ZIP Download

- - release.yml
- logic.mjs
- ui.mjs
.gitignore
LICENSE
main.js
manifest.json
README.md
styles.css
versions.json

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Read your Obsidian notes — and your books — like an e-book.

MD Reader renders a note into fixed-size **pages** and lets you flip through them **sideways** — by swiping, tapping the screen edges, or using the arrow keys — instead of scrolling vertically. Choose a single page or a two-page book spread. Works on **desktop and mobile**.

It also **imports FB2, EPUB and TXT books into Markdown**, so a whole library lives inside your vault as ordinary notes you can link, quote and search like anything else.

## Features

### Reading

- **Horizontal page flip.** Swipe (mobile), tap the left/right third of the screen, use `←` / `→`, `A` / `D`, `Space` / `Shift+Space`, `PageUp` / `PageDown`, `Home` / `End`, the mouse wheel, or the on-screen `‹` `›` buttons.
- **Single page or two-page spread.** Two pages on wide screens, one on narrow windows and phones — or force a mode.
- **Remembers your place** in every note, as a fraction of the whole book — so it survives font-size, width and theme changes, and matches up between desktop and phone.
- **Table of contents, full-book search and bookmarks.** Tap the progress percentage in the status bar to open the menu (also available as commands).
- **Scrub the progress bar.** Drag it to move anywhere in the book; the percentage and the chapter you are heading for follow your finger. Landed in the wrong place? One step back returns you.
- **Chapter at a time.** `Shift+←` / `Shift+→` step through the table of contents, not through internal render blocks. Stepping back from the middle of a chapter returns to its start first, as e-readers do.
- **Time left.** The status bar says roughly how long the rest of the book will take, from *your* measured reading speed — it learns as you read, with no setting to set.
- **Open the note for editing.** Spotted a typo in your own note? The menu opens the source in a tab at the current chapter. Edits made anywhere in Obsidian show up in the reader by themselves.
- **Reading progress** in the status bar, weighted across the whole book, with the **current chapter** next to it — a bare number tells you nothing in a thousand-page novel.
- **Hyphenation follows the book,** not the interface: an English novel is not hyphenated by Russian rules just because Obsidian is in Russian.
- **Appearance panel.** Font size, line height, margins, page width, tint, brightness and page mode — from the reading menu, without leaving the book. On a phone that used to mean walking out of immersive mode into the plugin settings.
- **Font size on the fly.** `Ctrl/Cmd` `+` / `−` on the desktop, pinch with two fingers on the phone.
- **Back to where I was.** Jumped off to a heading, a search hit or a bookmark — one step returns you to the page you were reading (`Backspace`, `Alt+←`, or the menu).
- **The end.** The last page says so, and offers the library, or a way out, instead of a page that just won't turn.
- **Leaving puts everything back.** One action — the menu, a command, the end screen, or `Esc` twice — closes the reader and returns the workspace exactly as it was: side panels, header, tab bar, full screen, the OS status bar on a phone. The panel state is kept on disk, so it survives quitting Obsidian with a book open.
- **Immersive reading.** Hides the app header and the mobile/desktop bars so only the text remains. Tap the center of the page to bring them back. On desktop it can go into **real full screen**.
- **Big books stay fast — and it tunes itself.** Long files are rendered one block at a time. Column layout is strictly linear in the amount of text, so the reader times its own layout and picks the block size that fits in about one frame **on your machine**: roughly 55 000 characters on a fast desktop, down to 20 000 on a slow one, without a setting to fiddle with. The next block is prepared in the background — but only once you are past the middle of the current one, and only while the main thread is idle. Blocks you have already read stay parsed, so paging back costs nothing. A 3 MB novel opens and flips without freezing, on the phone too.
- **Reading comfort.** Reading font, page tint (sepia, cream, gray, night), brightness, justified text with hyphenation, adjustable margins, line height and page width.
- **Collapses the side panels** when you open a note, and restores them when you close the reader.
- **Theme-aware.** Uses your theme's fonts and colors unless you override them.
- **No vertical scrolling, no manual page breaks** — pagination is computed from the rendered Markdown automatically and re-flows on resize.

### Library and import

- **Library.** One ribbon icon opens a list of your books: everything in the import folder, any notes you add by hand, and the notes you have recently read, each with a progress bar, sorted by when you last read it. **Continue** at the top reopens the last book straight away; a filter appears once the list grows.
- **Import books to Markdown.** `.fb2`, `.epub` and `.txt` are converted into a single `.md` file (chapters become headings, so the table of contents works) plus a folder with the book's images. Footnotes are inlined, epigraphs become quotes, the cover is kept. Cyrillic encodings such as windows-1251 are detected automatically.
- **No dependencies, no build step.** The converters — including the EPUB unzipper — are plain JavaScript in the plugin itself.

## How to use

- Click the **book icon** in the left ribbon to open the **Library**, then pick a book.
- Or open the current note: command **"Open current note in MD Reader"**, or **right-click** a note → **Open in MD Reader**.
- To import a book: the **import** button at the bottom of the Library, the command **"Import book to Markdown (fb2, epub, txt)…"**, the button in settings, or **right-click** a `.fb2` / `.epub` / `.txt` file in the vault → **Convert to Markdown**.

While reading:

- **Turn pages:** swipe, tap the left/right edge, arrow keys, `A` / `D`, `Space`, mouse wheel, or the `‹` `›` buttons.
- **Toggle the interface:** tap the center of the page.
- **Menu:** tap the percentage in the status bar → table of contents, search, previous/next chapter, back to where you were, appearance, library, open the note for editing, add/remove bookmark, bookmarks, leave the reader.
- **Leave:** `Esc` once brings the interface back without leaving the book; `Esc` again closes the reader and restores the workspace. Also in the menu, as a command, and on the end screen.
- **Jump anywhere:** drag the progress bar at the very bottom. `Home` / `End` go to the start and the end of the whole book.
- **Resize the text:** `Ctrl/Cmd` `+` / `−`, or pinch with two fingers.
- **Select and copy** with the mouse — dragging across the text no longer flips the page.

### Commands

| Command | What it does |
| --- | --- |
| Open library | The list of your books. |
| Continue reading | Reopens the last book you read, where you left off. |
| Open current note in MD Reader | Opens the active note in the reader. |
| Open table of contents | Jump to any heading in the book. |
| Search in this book | Search the whole book and jump to a hit. |
| Next / Previous chapter | Step through the table of contents (`Shift+→` / `Shift+←`). |
| Open the note for editing | Opens the source in a tab, at the current chapter. |
| Leave the reader | Closes the book and puts the panels and the app chrome back. |
| Back to where I was | Undo a jump to a heading, hit or bookmark. |
| Appearance: font, tint, margins | The reading settings, without leaving the book. |
| Increase / Decrease font size | Same as `Ctrl/Cmd` `+` / `−` while reading. |
| Add / remove bookmark | Bookmark the current page. |
| Open bookmarks | Jump to a bookmark. |
| Toggle full screen | Desktop only. |
| Cycle page tint | Switch tint on the fly — handy in the evening. |
| Import book to Markdown (fb2, epub, txt)… | Pick a file and convert it. |

## Settings

| Setting | What it does |
| --- | --- |
| Page mode | Auto (two pages on a wide screen, one on a narrow one), Always one, or Always two. |
| Max page width | Width of a single page; smaller is a narrower, more comfortable column. 0 = no limit. |
| Font size | Multiplier relative to your theme's font. |
| Reading font | Typeface for the page text — only inside the reader. Includes a custom CSS `font-family` option. |
| Page tint | Sepia, cream, gray or night. Only the reader changes; the rest of Obsidian keeps your theme. |
| Brightness | Dim the page for reading in the dark. |
| Line height | Line spacing. |
| Gap between pages | Space between the two pages of a spread. |
| Vertical margins | Empty space at the top and bottom of the page. |
| Justify text | Align paragraphs to both edges, with hyphenation where the platform supports it. |
| Page-flip animation | Animate page turns on/off. |
| Tap zones | Tap left/right to flip, center to toggle the interface. |
| Remember position | Reopen each note where you left off. |
| Show note title | Show the note title on the first page. |
| Open in | New tab, current tab, split, or new window. |
| Collapse side panels | Hide the side panels while reading. |
| Immersive reading | Hide the app chrome for full-screen reading. |
| Full screen while reading | Desktop: open books in real full screen; `Esc` leaves at any time. |
| Folder for imported books | Where converted books and their images are saved. |
| Hide the system status bar (mobile) | On a phone, also hide the OS status bar (clock, notifications) while reading. Experimental. |

Interface language follows Obsidian — English and Russian.

## Installation

### From the Community Plugins catalog

Settings → Community plugins → Browse → search **"MD Reader"** → Install → Enable.

### Manual

Copy `main.js`, `manifest.json` and `styles.css` into
`<your vault>/.obsidian/plugins/md-reader/` and enable the plugin in
Settings → Community plugins.

## Development

The plugin is plain JavaScript with **no build step** — `main.js` is the source and ships as-is. To work on it, edit the files in the plugin folder and reload Obsidian (`Ctrl/Cmd-P` → "Reload app without saving").

There are two test files. They stub the `obsidian` module (and a minimal DOM) and run on bare Node, with no dependencies to install:

```
node tests/logic.mjs
node tests/ui.mjs
```

`logic.mjs` covers chapter splitting, heading scanning, reading position, chapter navigation, time left, language detection, encodings and the TXT converter; `ui.mjs` builds the library, the appearance panel and the settings tab, checks path handling on case-insensitive file systems and how the side panels are restored, and checks what came out.

## License

obsidian-md-reader

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README