mkdocs-pdf

Name	mkdocs-pdf JSON
Version	0.1.2 JSON
	download
home_page	None
Summary	MkDocs plugin for embedding PDFs in a Markdown way
upload_time	2024-04-22 10:35:49
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	MIT
keywords	mkdocs pdf embed
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MkDocs PDF

This plugin allows you to embed PDFs in your documentation using standard
Markdown syntax.

## Installation

Install the package with pip

```
pip install mkdocs-pdf
```

## Configuration

```yaml
# mkdocs.yml
markdown_extensions:
  - attr_list
plugins:
  - mkdocs-pdf
```

## Usage

To embed a PDF file simple use the following syntax.

```markdown
![Alt text](<path to pdf>){ type=application/pdf }
```

Optionally, you can specify style constraints, e.g.

```markdown
![Alt text](<path to pdf>){ type=application/pdf style="min-height:25vh;width:100%" }
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-pdf",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Thomas Rooijakkers <thomas.rooijakkers@tno.nl>",
    "keywords": "mkdocs, pdf, embed",
    "author": null,
    "author_email": "Thomas Rooijakkers <thomas.rooijakkers@tno.nl>",
    "download_url": "https://files.pythonhosted.org/packages/31/c4/5f57c1aacfe19aacf941c69d1f9f734b2f5b499c73f6f758af0d94529f5c/mkdocs_pdf-0.1.2.tar.gz",
    "platform": "any",
    "description": "# MkDocs PDF\n\nThis plugin allows you to embed PDFs in your documentation using standard\nMarkdown syntax.\n\n## Installation\n\nInstall the package with pip\n\n```\npip install mkdocs-pdf\n```\n\n## Configuration\n\n```yaml\n# mkdocs.yml\nmarkdown_extensions:\n  - attr_list\nplugins:\n  - mkdocs-pdf\n```\n\n## Usage\n\nTo embed a PDF file simple use the following syntax.\n\n```markdown\n![Alt text](<path to pdf>){ type=application/pdf }\n```\n\nOptionally, you can specify style constraints, e.g.\n\n```markdown\n![Alt text](<path to pdf>){ type=application/pdf style=\"min-height:25vh;width:100%\" }\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "MkDocs plugin for embedding PDFs in a Markdown way",
    "version": "0.1.2",
    "project_urls": {
        "Homepage": "https://github.com/ThomasTNO/mkdocs-pdf",
        "Source": "https://github.com/ThomasTNO/mkdocs-pdf"
    },
    "split_keywords": [
        "mkdocs",
        " pdf",
        " embed"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "82100ad69ac0fc053f62c154a5d48442ec082bb6e41b0f43d0887348ef278217",
                "md5": "dbc7a8890a06b47a759f57467f4294d2",
                "sha256": "c78bb194400c8753d84570fbe04252e6f9ac1b357a8565f2964f7e8f5689af33"
            },
            "downloads": -1,
            "filename": "mkdocs_pdf-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dbc7a8890a06b47a759f57467f4294d2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 3323,
            "upload_time": "2024-04-22T10:35:45",
            "upload_time_iso_8601": "2024-04-22T10:35:45.961360Z",
            "url": "https://files.pythonhosted.org/packages/82/10/0ad69ac0fc053f62c154a5d48442ec082bb6e41b0f43d0887348ef278217/mkdocs_pdf-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "31c45f57c1aacfe19aacf941c69d1f9f734b2f5b499c73f6f758af0d94529f5c",
                "md5": "1c5164895bf86fd62d21d5c7b9f0bcc3",
                "sha256": "22bf70d514cf430db1620d0887b6679a7b1e45e683f6a9e76e42941b34d74c99"
            },
            "downloads": -1,
            "filename": "mkdocs_pdf-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "1c5164895bf86fd62d21d5c7b9f0bcc3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 2868,
            "upload_time": "2024-04-22T10:35:49",
            "upload_time_iso_8601": "2024-04-22T10:35:49.452682Z",
            "url": "https://files.pythonhosted.org/packages/31/c4/5f57c1aacfe19aacf941c69d1f9f734b2f5b499c73f6f758af0d94529f5c/mkdocs_pdf-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-22 10:35:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ThomasTNO",
    "github_project": "mkdocs-pdf",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mkdocs-pdf"
}