Skip to content

StephanOrgiazzi/revue

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Revue

Expo SDK Expo Router React React Native TypeScript NativeWind Bun Jest Platforms License: MIT Open Source

Read markdown like an article, not a raw text file.

Revue is an open source iOS and Android app that turns plain .md files into a focused, magazine-style reading experience with local-first storage, reader controls, table of contents navigation, and automatic progress restore.

Revue app screenshot

Contents

Why Revue

Markdown is a strong format for mobile reading because it is inherently responsive by structure and highly styleable in presentation. Revue builds on that foundation to turn plain .md files into a polished, readable experience across screen sizes.

  • Instant local import of your existing markdown files
  • Lightweight reader controls (theme and type scale)
  • Table-of-contents navigation for fast scanning
  • Auto-resume exactly where you stopped
  • iOS and Android support with web for development

Architecture

  • Local-first: markdown metadata and preferences are persisted with platform storage.
  • Native file access uses expo-file-system (file:// and content://).
  • Web supports URI-based imports (http, https, blob, data, and local paths).
  • Reader rendering pipeline:
    • Parse and normalize markdown
    • Remove frontmatter for content rendering
    • Convert markdown to HTML blocks
    • Render with react-native-render-html

How It Feels (Android/iOS)

  1. Import markdown.
  2. Read in a clean, distraction-free view.
  3. Jump sections instantly with table of contents.
  4. Return later and continue from the same spot.

Android also supports opening markdown from external apps through file/content intents configured in app.json.

Built with Modern Tooling

Built with a modern toolchain for fast iteration and reliability: Expo Router, React Native 0.81, TypeScript 5.9, Bun-first workflows, oxlint/oxfmt, and Jest.

Stack

  • Expo SDK
  • React Native
  • React 19
  • Expo Router
  • NativeWind
  • react-native-render-html
  • Bun (package manager and script runner)

Read in Browser

bun run web

Quick start (development)

bun install
bun run start
bun run web

Quality Checks

bun run lint
bun run typecheck
bun run test

Build

bunx eas-cli build -p android --profile preview

Scripts

Command Description
bun run start Expo start
bun run android Open Android target
bun run ios Open iOS target
bun run web Run web target
bun run prebuild Expo prebuild
bun run lint oxlint + oxfmt check
bun run format Auto-fix lint and format
bun run typecheck TypeScript --noEmit
bun run test Jest

Project docs

About

Revue is an open source iOS and Android app that turns plain .md files into a focused, magazine-style reading experience

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors