Skip to main content

Convert [x]it! to markdown

Project description

xit2md

Run tests codecov PyPI Version License Python Compatibility Code style: black

[x]it! 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

# 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

>>> 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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page