# Peruse

This workspace shows how Peruse renders Markdown, source code, and Git changes.

[View the project on GitHub](https://github.com/0xcadams/peruse).

## Try It

1. Open [`example.ts`](example.ts). Click a line number to link to it, then shift-click another line to select a range.
2. Open the **5 changes** menu. Compare the staged and unstaged edits to `example.ts`.
3. Open [Getting Started](guides/getting-started.md) to render a Mermaid diagram and all five GitHub alert types.
4. Follow the wiki link to [[notes]], then use the breadcrumbs to return here.
5. Open the theme menu and choose another light or dark syntax theme.

> [!TIP]
> The directory listing stays above this README, so you can open another file without returning to the root first.