Skip to main content

A command line tool that processes markdown files to replace quote blocks with actual content from referenced files.

Project description

markdown_quote

markdown_quote is a command-line tool that processes Markdown files to automatically replace special quote blocks with content extracted from referenced source files. It is especially useful for maintaining documentation with up-to-date code snippets.

Quote Block Syntax

Basic Format

<!-- quote_begin content="[description](file_path#Lstart_line-Lend_line)" lang="language" -->
up-to-date content
<!-- quote_end -->

Parameters

content: Specifies the file and line range to quote

  • description: Optional description (currently unused)

  • file_path: Relative path to the source file

  • #Lstart_line-Lend_line: Line range (1-based inclusive). If omitted, the start or end of the file is used.

Examples:

L10-L20: from line 10 to line 20

L-L: the entire file

L10-L: from line 10 to the end

L-L30: from the start to line 30

lang: Programming language for syntax highlighting

Usage

Install markdown_quote

pip install markdown_quote

Navigate to your project folder and run:

markdown_quote

This command updates all quote blocks in Markdown files within the directory.

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

markdown_quote-0.0.3.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

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

markdown_quote-0.0.3-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file markdown_quote-0.0.3.tar.gz.

File metadata

  • Download URL: markdown_quote-0.0.3.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for markdown_quote-0.0.3.tar.gz
Algorithm Hash digest
SHA256 928f05e66401bc0f26c8810a2235a5dbb8b277ec89300d58d072cb149446967d
MD5 26d09308344dd649d038e906e4ec192a
BLAKE2b-256 1915a6fb48187ec6b4ceac9c94a2694f507bad0b2b139142211def3c951560e5

See more details on using hashes here.

File details

Details for the file markdown_quote-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: markdown_quote-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for markdown_quote-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 586ddc165cb2185af830f317208b53f365b61b5048e1f94aa8af2f441f0d2c7f
MD5 c0088773df4896313b62a100abb47d1f
BLAKE2b-256 27fde0a7496421060a5273b3b29ca8c714ab3c071b24a0353858a1cb69741f40

See more details on using hashes here.

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