Skip to main content

comment-preserving docx <-- --> markdown converter

Project description

Commentary

Commentary is a command line document conversion tool and pandoc filter that preserves native-style comments between Markdown and docx files.

Installation

pip install commentary

Basic Usage

echo 'Hello <!-- this is a comment --> world' > doc.md

# convert from md to docx using the CLI
commentary doc.md -o out.docx

# or invoke as a filter from pandoc
pandoc doc.md -F commentary-filter --wrap=none -o out.docx

# add metadata to your markdown comments
commentary doc.md -o doc.md

See documentation for full usage guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

commentary-0.3.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file commentary-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: commentary-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.11.0 pkginfo/1.7.0 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.10

File hashes

Hashes for commentary-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 edfa78e36f8ee6d3edf85dc0c97d8a6c855edb3a506914f37d9d453863d2db67
MD5 15ad1cf48db222e2636a30efd4fe0766
BLAKE2b-256 b81096e5e267526ca56669ea19391f03e0168f1cd55f4c105a00467eab47218d

See more details on using hashes here.

Supported by

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