Metadata-Version: 2.4
Name: md2atxt
Version: 0.2.1
Summary: Convert markdown notes to anki notes
Project-URL: Homepage, https://github.com/tifrueh/md2atxt
Project-URL: Issues, https://github.com/tifrueh/md2atxt/issues
Author-email: Timo Früh <dev@tifrueh.ch>
License-Expression: MIT
License-File: LICENSE.txt
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# md2atxt

**md2atxt** is a small program that can be used to convert notes written in
Markdown (in a format specified in **md2atxt.md**(5)) to Anki-importable text
files.

## Installation

### Dependencies

For **md2atxt** to work, the following programs need to be installed and in the
PATH:

* [pandoc](https://pandoc.org/index.html)

*Note: If you are installing with a system-wide package manager like `pacman` or
`brew`, these dependencies should be automatically installed for you. `pipx`
however, as it provides user-local packages, does not do this and you'll have to
install them manually.*

### pipx (Cross-Platform)

**md2atxt** can be installed from the PyPI via `pipx`:

```console
$ pipx install md2atxt
```

Alternatively, `pipx` can also be used to install **md2atxt** directly from a
checked out working tree (or downloaded archive) of this repository:

```console
$ git clone https://github.com/tifrueh/md2atxt.git md2atxt
$ cd md2atxt
$ pipx install .
```

### Homebrew (macOS)

After tapping the corresponding tap, you should be able to install **md2atxt**
like you would any other package:

```console
$ brew tap tifrueh/mytap
$ brew install tifrueh/mytap/md2atxt
```

### PKGBUILD (Arch Linux)

You can find a PKGBUILD in [my PKGBUILD
repository](https://github.com/tifrueh/PKGBUILDs/tree/main/md2atxt). Download it
or clone the repository and then use makepkg and pacman to install it as you
would a package from the AUR.

## Documentation

**md2atxt** is documented in the form of manual pages, which can also be found
in Markdown format in the [Documentation](./Documentation) directory.
**md2atxt**(1) is probably a good starting point.
