MCPcopy Index your code
hub / github.com/arto-app/Arto

github.com/arto-app/Arto @v0.26.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.26.0 ↗ · + Follow
1,498 symbols 3,568 edges 181 files 410 documented · 27%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Arto

Arto — the Art of Reading Markdown.

A local app that faithfully recreates GitHub-style Markdown rendering for a beautiful reading experience.

Philosophy

Markdown has become more than a lightweight markup language — it's the medium for documentation, communication, and thinking in the developer's world. While most tools focus on writing Markdown, Arto is designed for reading it beautifully.

The name "Arto" comes from "Art of Reading" — reflecting the philosophy that reading Markdown is not just a utility task, but a quiet, deliberate act of understanding and appreciation.

Arto faithfully reproduces GitHub's Markdown rendering in a local, offline environment, offering a calm and precise reading experience with thoughtful typography and balanced whitespace.

[!WARNING] Beta Software Notice

  • This application is still in beta and may contain bugs or unstable behavior. Features may change without regard to backward compatibility.
  • macOS Only: This application is currently designed exclusively for macOS and does not support other platforms. However, cross-platform support is a long-term goal, and PRs are welcome.

Features

Core Reading Experience

  • GitHub-Style Rendering — Accurate reproduction of GitHub's Markdown styling with full support for extended syntax
  • Native Performance — Built with Rust for fast, responsive rendering
  • Auto-Reload — Automatically updates when the file changes on disk
  • Offline First — No internet connection required — read your docs anytime, anywhere

Navigation & Organization

  • File Explorer — Built-in sidebar with file tree navigation for browsing local directories
  • Quick Access — Bookmark frequently used files and directories for instant access
  • Directory History — Back/forward navigation within the sidebar file explorer
  • Table of Contents — Automatic TOC panel for easy document navigation
  • Live Navigation — Navigate between linked markdown documents with history support (back/forward)

Search & Discovery

  • Find in Page — Search within documents with Cmd+F
  • Pinned Search — Pin search queries with persistent multi-color highlighting across sessions

Window & Tab Management

  • Tab Support — Open and manage multiple documents in tabs within a single window
  • Multi-Window — Create multiple windows and open child windows for diagrams
  • Cross-Window Tabs — Drag and drop tabs between windows
  • Drag & Drop — Simply drag markdown files onto the window to open them

Advanced Rendering

  • Mermaid Diagrams — Interactive diagram viewer with zoom, pan, and copy-as-image
  • Math Expressions — Beautiful KaTeX rendering for mathematical notation
  • Code Highlighting — Syntax highlighting with copy button for code blocks
  • Frontmatter — Renders YAML frontmatter as a styled, collapsible table
  • GitHub Alerts — Full support for NOTE, TIP, IMPORTANT, WARNING, and CAUTION alerts

Customization

  • Dark Mode — Manual and automatic theme switching based on system preferences
  • Zoom Controls — Keyboard shortcuts and trackpad gestures for zoom
  • Preferences — Configurable settings for sidebar, TOC, and more
  • Context Menus — Right-click menus for quick actions on files and content

Installation

Use Homebrew tap to install. Since the application is not signed or notarized with an Apple Developer ID, you'll need to remove the quarantine attribute after installation. See homebrew-tap for more information.

brew install --cask arto-app/tap/arto
xattr -dr com.apple.quarantine /Applications/Arto.app

Alternatively, Nix is also supported. To try it without a permanent installation:

nix run github:arto-app/Arto

For a permanent installation, use nix-darwin or home-manager. Add the following to your flake inputs:

arto.url = "github:arto-app/Arto";

Then add it to environment.systemPackages (nix-darwin) or home.packages (home-manager):

environment.systemPackages = [ inputs.arto.packages.${system}.default ];

Launch the application to see the welcome screen with keyboard shortcuts and usage instructions.

Usage

After installation, the arto command becomes available in your terminal:

arto                     # Launch Arto (shows welcome screen)
arto README.md           # Open a specific file
arto --open=screen README.md
arto --open=new README.md
arto --directory=. README.md
arto docs/               # Open a directory in the file explorer
arto file1.md file2.md   # Open multiple files in tabs

Arto runs as a single instance — if Arto is already running, the command sends requests to the existing process instead of launching a new one.

  • arto FILE uses last_focused behavior by default (reuse last focused visible window).
  • --open=screen opens on/reuses a visible window on the cursor's current screen.
  • --open=new always opens in a new window.
  • --directory=DIR sets the FileExplorer root directory for that invocation.
  • Positional directory arguments (e.g. arto docs/) also set the root directory.
  • Running arto without arguments shows/focuses an existing window if hidden, or opens one if none exists.

Official Website

Visit arto-app.github.io for screenshots, feature highlights, and more.

Contributing

See CONTRIBUTING.md for development setup and guidelines.

License

See LICENSE file for details.

Extension points exported contracts — how you extend this code

DisplayLike (Interface)
(no doc) [2 implementers]
desktop/src/utils/screen.rs
ViewerState (Interface)
* Base viewer controller with common zoom/pan operations. * Provides a foundation for specialized viewers like Mermaid,
renderer/src/base-viewer-controller.ts
CodePosition (Interface)
* Explicit position within the DOM for code block line computation.
renderer/src/context-menu-handler.ts
DetectedContext (Interface)
* Result of detecting the context of a right-click. * Block elements (mermaid, math, image) include their source line r
renderer/src/context-menu-handler.ts
Window (Interface)
(no doc)
renderer/src/image-window-controller.ts
PinnedSearchDef (Interface)
(no doc)
renderer/src/find-in-page.ts

Core symbols most depended-on inside this repo

push
called by 118
desktop/src/history.rs
is_empty
called by 71
desktop/src/history.rs
len
called by 70
desktop/src/history.rs
path
called by 66
desktop/src/state/persistence.rs
as_ref
called by 47
desktop/src/pinned_search.rs
contains
called by 45
desktop/src/bookmarks.rs
render_to_html
called by 30
desktop/src/markdown.rs
add
called by 27
desktop/src/bookmarks.rs

Shape

Function 1,144
Method 194
Class 99
Enum 42
Interface 19

Languages

Rust84%
TypeScript16%

Modules by API surface

desktop/src/markdown/autolinks.rs51 symbols
desktop/src/window/settings.rs49 symbols
desktop/src/keybindings/dispatcher.rs49 symbols
desktop/src/shortcut.rs48 symbols
desktop/src/markdown.rs41 symbols
desktop/src/pinned_search.rs36 symbols
renderer/src/content-cursor.ts34 symbols
desktop/src/window/main.rs33 symbols
desktop/src/ipc.rs31 symbols
desktop/src/components/tab/calculations.rs29 symbols
desktop/src/keybindings/engine.rs28 symbols
desktop/src/utils/source_extract.rs26 symbols

For agents

$ claude mcp add Arto \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page