Getting Started

Welcome to Mark! This guide will help you get up and running with the markdown viewer in just a few minutes.

First Steps

After installing Mark, let’s start with the basics.

Viewing a Single File

The simplest way to use Mark is to view a single markdown file:

mark README.md

This will open the file in Mark’s terminal interface where you can:

• Scroll through the content with arrow keys
• Navigate sections with Page Up/Page Down
• Press q to quit

Browsing a Directory

Mark can also browse through multiple markdown files in a directory:

mark ./docs/

This opens a file browser where you can:

• Use arrow keys to navigate files
• Press Enter to open a file
• Press Escape to go back to the file list

Basic Navigation

Keyboard Shortcuts

Configuration

Mark uses a TOML configuration file for customization. Create a config file at:

• Linux/macOS: ~/.config/mark/config.toml
• Windows: %APPDATA%\mark\config.toml

Basic Configuration

// TODO

Reading Documentation

# Browse project documentation
mark ./project-docs/

# Read a specific guide
mark ./project-docs/user-guide.md

2. Configuration Profiles

You can use different configurations for different contexts:

# Use work configuration
mark --config ~/.config/mark/config1.toml document.md

# Use presentation theme
mark --config ~/.config/mark/config2.toml slides.md

Common Use Cases

Documentation Reading

Perfect for browsing project documentation, API references, and technical guides without leaving the terminal.

Code Review

Quickly review README files, changelogs, and documentation changes during code reviews.

Writing and Editing

Use Mark alongside your favorite editor to preview markdown as you write.

Presentations

Use Mark’s clean rendering for terminal-based presentations and demos.

What’s Next?

• Learn about Configuration options
• Explore Usage Examples for advanced workflows
• Check out the Developer Guide to contribute

Getting Help

If you need help:

• Press ? in Mark to see keyboard shortcuts
• Visit the GitHub repository for issues and discussions