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.3.tar.gz (44.5 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.3-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: publishmd-1.0.3.tar.gz
  • Upload date:
  • Size: 44.5 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.3.tar.gz
Algorithm Hash digest
SHA256 9fc61ef61f75d42b9606096624b7e5e075eff5e33daebae97e6ca09caf273a85
MD5 7e4b08288b6be3979ad8aeb0f34446ef
BLAKE2b-256 da09fe7a42196a748abbae12b307d66982352778fd0e2012ad82c941139916b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for publishmd-1.0.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: publishmd-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 35.9 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 87ab2cc65b1e4dcafbe704f7fe7be383f4609713700c01ffffe178f2d3e80c63
MD5 d2ea6c9c014266c88f7b5b66b2c65a3b
BLAKE2b-256 08c0d302627516e5eb86f7c0d73595b334c196145bdc2c8bfd2800ed8302ddea

See more details on using hashes here.

Provenance

The following attestation bundles were made for publishmd-1.0.3-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