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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markdown_quote-0.0.2.tar.gz.
File metadata
- Download URL: markdown_quote-0.0.2.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84c50f1a5574187c8b5ec498840862aee19457818cb4037ce3c5e2abd95568ed
|
|
| MD5 |
57fdfd8d1b25c10281a9f1dbd0ba53b8
|
|
| BLAKE2b-256 |
6da9f68a6d4ba64622ff539833d4deb39624d0736d162ea87d184ae446e0a5de
|
File details
Details for the file markdown_quote-0.0.2-py3-none-any.whl.
File metadata
- Download URL: markdown_quote-0.0.2-py3-none-any.whl
- Upload date:
- Size: 12.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cc266745a7c2abd608ee62a8afed4f6dbf1d1ad38597aec684f8f9884b59da46
|
|
| MD5 |
e2866325160c3cb00317837fce51c28a
|
|
| BLAKE2b-256 |
a4d795f41aaeedc29543bd39cbcbc21a06435ff27582feade80fdf8733b78757
|