markdown-quote

Name	markdown-quote JSON
Version	0.0.1 JSON
	download
home_page	None
Summary	A command line tool that processes markdown files to replace quote blocks with actual content from referenced files.
upload_time	2025-10-15 14:23:26
maintainer	None
docs_url	None
author	None
requires_python	None
license	Apache License
keywords	cli command-line
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

```markdown
<!-- 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)

`lang`: Programming language for syntax highlighting

## Usage

Navigate to your project folder and run:
```
markdown_quote
```
This command updates all quote blocks in Markdown files within the directory.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "markdown-quote",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "cli, command-line",
    "author": null,
    "author_email": "ybbh <guohua@scupt.com>",
    "download_url": "https://files.pythonhosted.org/packages/de/50/fbe60387aea57b05f4d536a2ac6b31a50c5e9900c54993ca8334039c0a10/markdown_quote-0.0.1.tar.gz",
    "platform": null,
    "description": "# markdown_quote\r\n\r\n`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.\r\n\r\n## Quote Block Syntax\r\n\r\n### Basic Format\r\n\r\n```markdown\r\n<!-- quote_begin content=\"[description](file_path#Lstart_line-Lend_line)\" lang=\"language\" -->\r\nup-to-date content\r\n<!-- quote_end -->\r\n```\r\n\r\n### Parameters\r\n\r\n`content`: Specifies the file and line range to quote\r\n\r\n- `description`: Optional description (currently unused)\r\n\r\n- `file_path`: Relative path to the source file\r\n\r\n- `#Lstart_line-Lend_line`: Line range (1-based inclusive)\r\n\r\n`lang`: Programming language for syntax highlighting\r\n\r\n## Usage\r\n\r\nNavigate to your project folder and run:\r\n```\r\nmarkdown_quote\r\n```\r\nThis command updates all quote blocks in Markdown files within the directory.\r\n",
    "bugtrack_url": null,
    "license": "Apache License",
    "summary": "A command line tool that processes markdown files to replace quote blocks with actual content from referenced files.",
    "version": "0.0.1",
    "project_urls": {
        "Bug Reports": "https://github.com/scuptio/markdown_quote/issues",
        "Homepage": "https://github.com/scuptio/markdown_quote",
        "Repository": "https://github.com/scuptio/markdown_quote"
    },
    "split_keywords": [
        "cli",
        " command-line"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e5146e21ddb6725b66e6501a0fda3005a16ead1f7cf8c1072510ee7d7233c677",
                "md5": "68c0a560d353f53ce5db41a2b0443d41",
                "sha256": "c468d6f2e513b98c79ed9e1f0c5e01c1c01a551a2391f71a0d5f53196a8bb742"
            },
            "downloads": -1,
            "filename": "markdown_quote-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "68c0a560d353f53ce5db41a2b0443d41",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 10384,
            "upload_time": "2025-10-15T14:23:25",
            "upload_time_iso_8601": "2025-10-15T14:23:25.505954Z",
            "url": "https://files.pythonhosted.org/packages/e5/14/6e21ddb6725b66e6501a0fda3005a16ead1f7cf8c1072510ee7d7233c677/markdown_quote-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "de50fbe60387aea57b05f4d536a2ac6b31a50c5e9900c54993ca8334039c0a10",
                "md5": "bf636a7590e1f515b1fcb9fcf35126d8",
                "sha256": "d94e349a9933f1b4ae5217f6e31add376ad0e24afd983254afeeea9e325a85ad"
            },
            "downloads": -1,
            "filename": "markdown_quote-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "bf636a7590e1f515b1fcb9fcf35126d8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9380,
            "upload_time": "2025-10-15T14:23:26",
            "upload_time_iso_8601": "2025-10-15T14:23:26.605636Z",
            "url": "https://files.pythonhosted.org/packages/de/50/fbe60387aea57b05f4d536a2ac6b31a50c5e9900c54993ca8334039c0a10/markdown_quote-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-15 14:23:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "scuptio",
    "github_project": "markdown_quote",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "markdown-quote"
}