{
    "info": {
        "author": "Daniil Minukhin",
        "author_email": "ddddsa@gmail.com",
        "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": "![](https://img.shields.io/pypi/v/foliantcontrib.anchors.svg)\n\n# Anchors\n\nPreprocessor which allows to use arbitrary anchors in Foliant documents.\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.anchors\n```\n\n## Config\n\nTo enable the preprocessor, add anchors to preprocessors section in the project config:\n\n```yaml\npreprocessors:\n    - anchors\n```\n\nThe preprocessor has some options, but most probably you won't need any of them:\n\n```yaml\npreprocessors:\n    - anchors:\n        element: '<span id=\"{anchor}\"></span>'\n        tex: False\n```\n\n`element`\n:   Template of an HTML-element which will be placed instead of the `<anchor>` tag. In this template `{anchor}` will be replaced with the tag contents. Default: `'<span id=\"{anchor}\"></span>'`\n\n`tex`\n:   If this option is `True`, preprocessor will try to use TeX-language anchors: `\\hypertarget{anchor}{}`. Default: `False`\n\n> Notice, this option will work only with `pdf` target. For all other targets it is set to `False`.\n\n## Usage\n\nJust add an `anchor` tag to some place and then use an ordinary Markdown-link to this anchor:\n\n```html\n...\n\n<anchor>limitation</anchor>\nSome important notice about system limitation.\n\n...\n\nDon't forget about [limitation](#limitation)!\n\n```\n\nYou can also place anchors in the middle of paragraph:\n\n```html\n\nLorem ipsum dolor sit amet, consectetur adipisicing elit.<anchor>middle</anchor> Molestiae illum iusto, sequi magnam consequatur porro iste facere at fugiat est corrupti dolorum quidem sapiente pariatur rem, alias unde! Iste, aliquam.\n\n[Go to the middle of the paragraph](#middle)\n\n```\n\nYou can place anchors inside tables:\n\n```html\n\nName | Age | Weight\n---- | --- | ------\nMax  | 17  | 60\nJane | 98  | 12\nJohn | 10  | 40\nKaty | 54  | 54\nMike <anchor>Mike</anchor>| 22  | 299\nCinty| 25  | 42\n\n...\n\nSomething's wrong with Mike, [look](#Mike)!\n\n```\n\n## Additional info\n\n**1. Anchors are case sensitive**\n\n`Markdown` and `MarkDown` are two different anchors.\n\n**2. Anchors should be unique**\n\nYou can't use two anchors with the same name in one document.\n\nIf preprocessor notices repeating anchors in one md-file it will throw you a warning.\n\nIf there are repeating anchors in different md-files and they all go into single pdf or docx, all links will lead to the first one.\n\n**3. Anchors may conflict with headers**\n\nHeaders are usually assigned anchors of their own. Be careful, your anchors may conflict with them.\n\nPreprocessor will try to detect if you are using anchor which is already taken by the header and warn you in console.\n\nRemember, that header anchors are almost always in lower-case and almost never use special symbols except `-`.\n\n**4. Some symbols are restricted**\n\nYou can't use these symbols in anchors:\n\n```\n[]<>\\\"\n```\n\nAlso you can't use space.\n\n**5. But a lot of other symbols are available**\n\nAll these are valid anchors:\n\n```\n<anchor>!important!</anchor>\n<anchor>_anchor_</anchor>\n<anchor>section(1)</anchor>\n<anchor>section/1/</anchor>\n<anchor>anchor$1$</anchor>\n<anchor>about:info</anchor>\n<anchor>test'1';</anchor>\n<anchor>\u044f\u043a\u043e\u0440\u044c</anchor>\n<anchor>\ud83d\udc40</anchor>\n```\n\n\n## Notice for Mkdocs\n\nIn many Mkdocs themes the top menu lays over the text with absolute position. In this situation all anchors will be hidden by the menu.\n\nPossible solution is to use `element` option. Example config:\n\n```yaml\npreprocessors:\n    - anchors:\n        element: '<span style=\"display:block; margin:-3.1rem; padding:3.1rem;\" id=\"{anchor}\"></span>'\n```\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/foliant-docs/foliantcontrib.anchors",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "foliantcontrib.anchors",
        "package_url": "https://pypi.org/project/foliantcontrib.anchors/",
        "platform": "any",
        "project_url": "https://pypi.org/project/foliantcontrib.anchors/",
        "project_urls": {
            "Homepage": "https://github.com/foliant-docs/foliantcontrib.anchors"
        },
        "release_url": "https://pypi.org/project/foliantcontrib.anchors/1.0.2/",
        "requires_dist": [
            "foliant (>=1.0.8)",
            "foliantcontrib.utils.combined-options (>=1.0.1)",
            "foliantcontrib.utils.preprocessor-ext (>=1.0.2)"
        ],
        "requires_python": "",
        "summary": "Arbitrary anchors for Foliant.",
        "version": "1.0.2"
    },
    "last_serial": 5790246,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "babf21a5c013ea0a3a96eb9d97858d7a",
                    "sha256": "f0e13832ac4f814776f47653a8e3c9a3f14068a7ea0ce9c66a5fd086f212b68e"
                },
                "downloads": -1,
                "filename": "foliantcontrib.anchors-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "babf21a5c013ea0a3a96eb9d97858d7a",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 4940,
                "upload_time": "2019-03-21T13:57:44",
                "url": "https://files.pythonhosted.org/packages/1b/cf/8b4278ccba7b1bb3b7ce45089bea6f376fc4dd86082ed1e74d6fcaf512b8/foliantcontrib.anchors-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "65474547c9b650117e7c7cb7f6d396cf",
                    "sha256": "9f6934fb83db0a79c3c3ad05922158805314b9fad50a31877ea9fdc17a0484ca"
                },
                "downloads": -1,
                "filename": "foliantcontrib.anchors-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "65474547c9b650117e7c7cb7f6d396cf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4068,
                "upload_time": "2019-03-21T13:57:46",
                "url": "https://files.pythonhosted.org/packages/3f/0e/1b26c9ba426238ae2eacb605a7983f6dc01f893b005200acf50811f0fafb/foliantcontrib.anchors-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b1ef6ed2c1bbeafee37bcf831b86e6cd",
                    "sha256": "2dbba3657a02c5fc480b841569c3c301b5a0dc8a18ab25c796c689b2806de74a"
                },
                "downloads": -1,
                "filename": "foliantcontrib.anchors-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b1ef6ed2c1bbeafee37bcf831b86e6cd",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5258,
                "upload_time": "2019-04-01T13:30:42",
                "url": "https://files.pythonhosted.org/packages/80/35/32d891c2ec9d0171447bb843d0a39f0712a77f4b62e3d3dc1d562d283255/foliantcontrib.anchors-1.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "01ded84cd28ce09bbca9f7473abfe4d0",
                    "sha256": "1b04b618a072a89d3b61b6a3960ddff0abf509504c001e76625b544ae7f9f782"
                },
                "downloads": -1,
                "filename": "foliantcontrib.anchors-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "01ded84cd28ce09bbca9f7473abfe4d0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4446,
                "upload_time": "2019-04-01T13:30:43",
                "url": "https://files.pythonhosted.org/packages/8a/68/0b499b395a0dcacc452a0a5dea5d3f55cc9dcd1477138738345bd6673fa4/foliantcontrib.anchors-1.0.1.tar.gz"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6616fb41125a8b77593debe8e7c0b065",
                    "sha256": "8f4e8fd6439562fb2a362ad73dc6ae96d03a7d9d5e66d526a72741af0829d36f"
                },
                "downloads": -1,
                "filename": "foliantcontrib.anchors-1.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6616fb41125a8b77593debe8e7c0b065",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5268,
                "upload_time": "2019-07-29T09:51:13",
                "url": "https://files.pythonhosted.org/packages/20/50/30b18c2a366f2d6f837108e80fd04566ff20dca97269b26fc85e8a5582d5/foliantcontrib.anchors-1.0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "7683d1a3d1ffc1c9e3c57d316265a3a1",
                    "sha256": "1a43adb778d941f2a2e5df1424fbf8b0806429aaee409314ee7d1afb79df1190"
                },
                "downloads": -1,
                "filename": "foliantcontrib.anchors-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "7683d1a3d1ffc1c9e3c57d316265a3a1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4459,
                "upload_time": "2019-07-29T09:51:15",
                "url": "https://files.pythonhosted.org/packages/18/78/df5606c1b90985a53bc1cbd3a621c1f8b76c54f8fcace2593fa38561b226/foliantcontrib.anchors-1.0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6616fb41125a8b77593debe8e7c0b065",
                "sha256": "8f4e8fd6439562fb2a362ad73dc6ae96d03a7d9d5e66d526a72741af0829d36f"
            },
            "downloads": -1,
            "filename": "foliantcontrib.anchors-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6616fb41125a8b77593debe8e7c0b065",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5268,
            "upload_time": "2019-07-29T09:51:13",
            "url": "https://files.pythonhosted.org/packages/20/50/30b18c2a366f2d6f837108e80fd04566ff20dca97269b26fc85e8a5582d5/foliantcontrib.anchors-1.0.2-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "7683d1a3d1ffc1c9e3c57d316265a3a1",
                "sha256": "1a43adb778d941f2a2e5df1424fbf8b0806429aaee409314ee7d1afb79df1190"
            },
            "downloads": -1,
            "filename": "foliantcontrib.anchors-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7683d1a3d1ffc1c9e3c57d316265a3a1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4459,
            "upload_time": "2019-07-29T09:51:15",
            "url": "https://files.pythonhosted.org/packages/18/78/df5606c1b90985a53bc1cbd3a621c1f8b76c54f8fcace2593fa38561b226/foliantcontrib.anchors-1.0.2.tar.gz"
        }
    ]
}