Skip to main content

Prepare markdown content for publication with configurable processing pipeline

Project description

publishmd

PyPI Docs

Prepare markdown content for publication with configurable processing pipeline.

Use Case 1. Transform an Obsidian vault into publication-ready content for a Quarto blog. Convert wikilinks, filter content, copy assets, and apply transformations to prepare your notes for publishing.

Installation

pip install publishmd

# With WebP image conversion support
pip install "publishmd[webp]"

Usage

publishmd -c _config.yml
publishmd -c _config.yml -i ./vault -o ./dist

Configuration

Create a YAML configuration file to specify the processing pipeline, e.g.:

# _config.yml
input_dir: vault
output_dir: dist

filters:
  - name: published_only
    type: publishmd.filters.frontmatter_filter.FrontmatterFilter
    config:
      publish: true

transformers:
  - name: wikilinks
    type: publishmd.transformers.wikilink_transformer.WikilinkTransformer
    config:
      preserve_aliases: true
      link_extension: ".qmd"
  - name: stale_links
    type: publishmd.transformers.stale_links_transformer.StaleLinksTransformer
    config:
      convert_to_text: true

For the full configuration reference and all available filters/transformers, see the docs.

Development

pip install -e ".[dev]"
pytest

Project details


Download files

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

Source Distribution

publishmd-1.0.2.tar.gz (44.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

publishmd-1.0.2-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

Details for the file publishmd-1.0.2.tar.gz.

File metadata

  • Download URL: publishmd-1.0.2.tar.gz
  • Upload date:
  • Size: 44.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for publishmd-1.0.2.tar.gz
Algorithm Hash digest
SHA256 f72d421898aab22f5a7b3ef86628c2ddc52429d4ed985bf4918a7dca47aa8296
MD5 bfee0e46ddc95cbc8d12f53d479dfe2a
BLAKE2b-256 1718d2e559f36cfb5ff6f158a9310bffafa5f6287ff1de9201d7e71b9d72ef98

See more details on using hashes here.

Provenance

The following attestation bundles were made for publishmd-1.0.2.tar.gz:

Publisher: release.yml on MateusMolina/publishmd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file publishmd-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: publishmd-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for publishmd-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c7a8ced4df974e7a05073305a88c49ed4ee8c79510131504633e0e9e8fe6617f
MD5 bc8d570d87a6ce72577243427927c718
BLAKE2b-256 a79394428ef763ed81ef642c2c9e150fd84160271c4fd66b336b5edb933f560f

See more details on using hashes here.

Provenance

The following attestation bundles were made for publishmd-1.0.2-py3-none-any.whl:

Publisher: release.yml on MateusMolina/publishmd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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