{ "info": { "author": "Artemy Lomov", "author_email": "artemy@lomov.ru", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "# ImgCaptions\n\nImgCaptions is a preprocessor that generates visible captions for the images from alternative text descriptions of the images. The preprocessor is useful in projects built with MkDocs or another backend that provides HTML output.\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.imgcaptions\n```\n\n## Usage\n\nTo enable the preprocessor, add `imgcaptions` to `preprocessors` section in the project config:\n\n```yaml\npreprocessors:\n - imgcaptions\n```\n\nThe preprocessor supports the following options:\n\n```yaml\n - imgcaptions:\n stylesheet_path: !path imgcaptions.css\n targets:\n - pre\n - mkdocs\n - site\n - ghp\n```\n\n`stylesheet_path`\n: Path to the CSS stylesheet file. This stylesheet should define rules for the `.image_caption` class. Default path is `imgcaptions.css`. If stylesheet file does not exist, default built-in stylesheet will be used.\n\n`targets`\n: Allowed targets for the preprocessor. If not specified (by default), the preprocessor applies to all targets.\n\nImage definition example:\n\n```markdown\n(leading exclamation mark here)[My Picture](picture.png)\n```\n\nThis Markdown source will be finally transformed into the HTML code:\n\n```html\n

\"My

\n

My Picture

\n```\n\n(Note that ImgCaptions preprocessor does not convert Markdown syntax into HTML; it only inserts HTML tags `

My Picture

` into Markdown code after the image definitions. Empty alternative text descriptions are ignored.)\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/foliant-docs/foliantcontrib.imgcaptions", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "foliantcontrib.imgcaptions", "package_url": "https://pypi.org/project/foliantcontrib.imgcaptions/", "platform": "any", "project_url": "https://pypi.org/project/foliantcontrib.imgcaptions/", "project_urls": { "Homepage": "https://github.com/foliant-docs/foliantcontrib.imgcaptions" }, "release_url": "https://pypi.org/project/foliantcontrib.imgcaptions/1.0.1/", "requires_dist": null, "requires_python": "", "summary": "Preprocessor for Foliant for adding visible captions to images.", "version": "1.0.1" }, "last_serial": 5759660, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "989898dc97a22cda6aaa11e6305fe257", "sha256": "64f13ce7932e2153070dbffce7906ac39775584c1597fbfae3beb32aaf9328e5" }, "downloads": -1, "filename": "foliantcontrib.imgcaptions-1.0.0.tar.gz", "has_sig": false, "md5_digest": "989898dc97a22cda6aaa11e6305fe257", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2896, "upload_time": "2018-10-11T13:26:52", "url": "https://files.pythonhosted.org/packages/01/cb/b82c560d1088d07831be92a40ee5793b28338a3b2c401dfc0bdae22abf83/foliantcontrib.imgcaptions-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "294e9e1e80170f6abf9524a8312012d9", "sha256": "b34e93c8e11b824179fac5d3875b38006a58b1ed94ec6a25c27c1cdfed596984" }, "downloads": -1, "filename": "foliantcontrib.imgcaptions-1.0.1.tar.gz", "has_sig": false, "md5_digest": "294e9e1e80170f6abf9524a8312012d9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2914, "upload_time": "2018-11-16T13:18:32", "url": "https://files.pythonhosted.org/packages/d6/a1/65a869655f06fa9376cb688756df3b85fa577c709b4bfa42a5cc26742049/foliantcontrib.imgcaptions-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "294e9e1e80170f6abf9524a8312012d9", "sha256": "b34e93c8e11b824179fac5d3875b38006a58b1ed94ec6a25c27c1cdfed596984" }, "downloads": -1, "filename": "foliantcontrib.imgcaptions-1.0.1.tar.gz", "has_sig": false, "md5_digest": "294e9e1e80170f6abf9524a8312012d9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2914, "upload_time": "2018-11-16T13:18:32", "url": "https://files.pythonhosted.org/packages/d6/a1/65a869655f06fa9376cb688756df3b85fa577c709b4bfa42a5cc26742049/foliantcontrib.imgcaptions-1.0.1.tar.gz" } ] }