https://github.com/chris48s/xit2md

Convert [x]it! to markdown
https://github.com/chris48s/xit2md

todo

Last synced: 4 months ago
JSON representation

Convert [x]it! to markdown

• Host: GitHub
• URL: https://github.com/chris48s/xit2md
• Owner: chris48s
• License: mit
• Created: 2022-11-21T17:10:39.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-11T18:56:26.000Z (5 months ago)
• Last Synced: 2024-09-12T05:08:04.812Z (5 months ago)
• Topics: todo
• Language: Python
• Homepage: https://pypi.org/project/xit2md/
• Size: 218 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# xit2md

[![Run tests](https://github.com/chris48s/xit2md/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/chris48s/xit2md/actions/workflows/test.yml)

[![codecov](https://codecov.io/gh/chris48s/xit2md/branch/main/graph/badge.svg?token=8W93RI841H)](https://codecov.io/gh/chris48s/xit2md)

[![PyPI Version](https://img.shields.io/pypi/v/xit2md.svg)](https://pypi.org/project/xit2md/)

![License](https://img.shields.io/pypi/l/xit2md.svg)

![Python Compatibility](https://img.shields.io/badge/dynamic/json?query=info.requires_python&label=python&url=https%3A%2F%2Fpypi.org%2Fpypi%2Fxit2md%2Fjson)

![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)

[[x]it!](https://xit.jotaen.net/) is a plain-text file format for todos and check lists. xit2md converts a checklist in [x]it! format to markdown task lists. Markdown task lists are available in many markdown dialects including GitHub Flavored Markdown.

## Installation

```

pip install xit2md

```

## Usage

### On the Console

```sh

# convert [x]it! file to markdown file

$ xit2md in.xit > out.md

# fetch [x]it! file from the web and convert to markdown

$ curl "https://myserver.com/example.xit" | xit2md

```

### As a Library

```pycon

>>> from xit2md import xit2md_text

>>> xit = """Named Group

... [ ] Open

... [x] Checked

... [@] Ongoing

... [~] Obsolete

... [?] In Question

... """

>>> print(xit2md_text(xit, heading_level=2))

## Named Group

- [ ] Open

- [x] Checked

- [ ] Ongoing

- [x] ~Obsolete~

- [ ] In Question

```