Metadata-Version: 2.1
Name: amdreader
Version: 0.9.2
Summary: A Markdown document viewer for the terminal
Home-page: https://github.com/eivl/amdreader
License: MIT
Author: Eivind Teig
Author-email: eivind.teig@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Dist: httpx (>=0.24.1,<0.25.0)
Requires-Dist: textual (==0.53.1)
Requires-Dist: typing-extensions (>=4.5.0,<5.0.0)
Requires-Dist: xdg (>=6.0.0,<7.0.0)
Description-Content-Type: text/markdown


<p align="center">
  <img src="amd-logo.png"  width="600" align="center"/>
</p>


# AMD Reader


AMD reader is a Markdown viewer / browser for your terminal, built with [Textual](https://github.com/Textualize/textual).
It is a hard fork from Textualize and all credits goes to their work. This derived work adds custom features and improvements.
amd can open `*.md` files locally or via a URL.
There is a familiar browser-like navigation stack, history, bookmarks, and table of contents.


## Compatibility

amd runs on Linux, macOS, and Windows. amd requires Python **3.8** or above.


## Installing

The easiest way to install amd is with [pipx](https://pypa.github.io/pipx/) (particularly if you aren't a Python developer).

```
pipx install amdreader
```

You can also install amd with `pip`:

```
pip install amdreader
```

Whichever method you use, you should have a `amd` command on your path.

## Running

Enter `amd` at the prompt to run the app, optionally followed by a path to a Markdown file:

```
amd README.md
```

You can navigate with the mouse or the keyboard.
Use <kbd>tab</kbd> and <kbd>shift</kbd>+<kbd>tab</kbd> to navigate between the various controls on screen.

## Features

You can load README files direct from GitHub repositories with the `gh` command.
Use the following syntax:

```
amd gh textualize/textual
```

This also works with the address bar in the app.
See the help (<kbd>F1</kbd>) in the app for details.

