{ "info": { "author": "Dustin Burke", "author_email": "dustin@datarobot.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# mkdocs-redirects\n\nPlugin for [`mkdocs`](https://www.mkdocs.org/) to create page redirects (e.g. for moved/renamed pages).\n\n## Installing\n\n> **Note:** This package requires MkDocs version 1.0.4 or higher.\n\nInstall with pip:\n\n```bash\npip install mkdocs-redirects\n```\n\n## Using\n\nTo use this plugin, specify your desired redirects in the plugin's `redirect_maps` setting in your `mkdocs.yml`:\n\n```yaml\nplugins:\n - redirects:\n redirect_maps:\n 'old.md': 'new.md'\n 'old/file.md': 'new/file.md'\n 'some_file.md': 'http://external.url.com/foobar'\n```\n\n_Note: don't forget that specifying the `plugins` setting will override the defaults if you didn't already have it set! See [this page](https://www.mkdocs.org/user-guide/configuration/#plugins) for more information._\n\nThe redirects map should take the form of a key/value pair:\n\n- The key of each redirect is the original _markdown doc_ (relative to the `docs_dir` path).\n - This plugin will handle the filename resolution during the `mkdocs build` process.\n This should be set to what the original markdown doc's filename was (or what it _would be_ if it existed), not the final HTML file rendered by MkDocs\n- The value is the _redirect target_. This can take the following forms:\n - Path of the _markdown doc_ you wish to be redirected to (relative to `docs_dir`)\n - This plugin will handle the filename resolution during the `mkdocs build` process.\n This should be set to what the markdown doc's filename is, not the final HTML file rendered by MkDocs\n - External URL (e.g. `http://example.com`)\n\nDuring the `mkdocs build` process, this plugin will create `.html` files in `site_dir` for each of the \"old\" file that redirects to the \"new\" path.\nIt will produce a warning if any problems are encountered or of the redirect target doesn't actually exist (useful if you have `strict: true` set).\n\n### `use_directory_urls`\n\nIf you have `use_directory_urls: true` set (which is the default), this plugin will modify the redirect targets to the _directory_ URL, not the _actual_ `index.html` filename.\nHowever, it will create the `index.html` file for each target in the correct place so URL resolution works.\n\nFor example, a redirect map of `'old/dir/README.md': 'new/dir/README.md'` will result in an HTML file created at `$site_dir/old/dir/index.html` which redirects to `/new/dir/.\n\nAdditionally, a redirect map of `'old/dir/doc_name.md': 'new/dir/doc_name.md'` will result in `$site_dir/old/dir/doc_name/index.html` redirecting to `/new/dir/doc_name/`\n\nThis mimcs the behavior of how MkDocs builds the site dir without this plugin.\n\n## Contributing\n\n- Pull Requests are welcome.\n- File bugs and suggestions in the [Github Issues tracker](https://github.com/datarobot/mkdocs-redirects/issues).\n\n## Releasing\n\n```bash\nmake release\n```\n\nIt will prompt you for your PyPI user and password.\n\nSee:\n- https://packaging.python.org/tutorials/packaging-projects/\n- https://packaging.python.org/guides/migrating-to-pypi-org/", "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/datarobot/mkdocs-redirects", "keywords": "mkdocs redirect", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "mkdocs-redirects", "package_url": "https://pypi.org/project/mkdocs-redirects/", "platform": "", "project_url": "https://pypi.org/project/mkdocs-redirects/", "project_urls": { "Homepage": "https://github.com/datarobot/mkdocs-redirects" }, "release_url": "https://pypi.org/project/mkdocs-redirects/1.0.0/", "requires_dist": null, "requires_python": ">=2.7", "summary": "A MkDocs plugin for dynamic page redirects to prevent broken links.", "version": "1.0.0" }, "last_serial": 5687858, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "14e485d6080fdf0adfe59e8b5dfa49fd", "sha256": "03c710823b837d5598869053e3dae8c1ce954e4d82f6504e273b73213d628323" }, "downloads": -1, "filename": "mkdocs-redirects-0.0.1.tar.gz", "has_sig": false, "md5_digest": "14e485d6080fdf0adfe59e8b5dfa49fd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 2699, "upload_time": "2019-04-03T15:26:54", "url": "https://files.pythonhosted.org/packages/ee/76/717947b0996e20f396c69d13e9ae3a77ef5bd04c24f8b923d7418a857662/mkdocs-redirects-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "217ddac4f71eaeb32982b86d65fb115e", "sha256": "587ef0bd2064eccb4a5a8e961eec6b5173afe530a5482791847e7e4c4969d327" }, "downloads": -1, "filename": "mkdocs-redirects-0.0.2.tar.gz", "has_sig": false, "md5_digest": "217ddac4f71eaeb32982b86d65fb115e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 2739, "upload_time": "2019-04-03T15:30:49", "url": "https://files.pythonhosted.org/packages/9a/54/7cb060d3d248215e176f982f864a0fefca65f5b3157003973f913edef965/mkdocs-redirects-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "d5c097499c175d321e4ca62302d1d64b", "sha256": "b6232483c52edb5d26bef1529e1cacdd999c7cff80654c02fbf8afe30ce83a92" }, "downloads": -1, "filename": "mkdocs-redirects-0.0.3.tar.gz", "has_sig": false, "md5_digest": "d5c097499c175d321e4ca62302d1d64b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 2984, "upload_time": "2019-04-05T18:31:08", "url": "https://files.pythonhosted.org/packages/c7/a2/b6f400ec2dc5d25cee62ef1dcf3d42134ddcf3fddd36f131e2c8009beb80/mkdocs-redirects-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "9c0fae2edf4abc3481f8dd22d076d619", "sha256": "872bbdca75bd95fb5266d20c3e0b01f6ae8ab3ce6435f0bd970ca300bf15f9e1" }, "downloads": -1, "filename": "mkdocs-redirects-0.0.4.tar.gz", "has_sig": false, "md5_digest": "9c0fae2edf4abc3481f8dd22d076d619", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 2966, "upload_time": "2019-04-09T17:18:44", "url": "https://files.pythonhosted.org/packages/39/ae/8acd283353c04fef25eb62dff2878283dad752502bbb9cd0ef5819d047c6/mkdocs-redirects-0.0.4.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "4d69e4701fbab972241afa13c819a945", "sha256": "0de62365343b04afb0b4dcc96463b8f70b772e08ee7b0d72c640111aa4965f66" }, "downloads": -1, "filename": "mkdocs-redirects-0.0.6.tar.gz", "has_sig": false, "md5_digest": "4d69e4701fbab972241afa13c819a945", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 3072, "upload_time": "2019-07-22T20:52:53", "url": "https://files.pythonhosted.org/packages/0f/0e/ba169458f97ff8a45bc06c589b803533014f5c2da540aeb3760d9f14dc16/mkdocs-redirects-0.0.6.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "8a56aa0a81850328adf8ab58adaa0f99", "sha256": "a1831fc7ea474668bad2611fb70d5d079390203d1dcd6a02cbd4d0838676ff30" }, "downloads": -1, "filename": "mkdocs-redirects-1.0.0.tar.gz", "has_sig": false, "md5_digest": "8a56aa0a81850328adf8ab58adaa0f99", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4698, "upload_time": "2019-08-16T14:11:32", "url": "https://files.pythonhosted.org/packages/d6/78/2cb84e6c1920f0cbcaa7cbca725a4463ff78c3eaa3d03d578570ebccd7b7/mkdocs-redirects-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8a56aa0a81850328adf8ab58adaa0f99", "sha256": "a1831fc7ea474668bad2611fb70d5d079390203d1dcd6a02cbd4d0838676ff30" }, "downloads": -1, "filename": "mkdocs-redirects-1.0.0.tar.gz", "has_sig": false, "md5_digest": "8a56aa0a81850328adf8ab58adaa0f99", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4698, "upload_time": "2019-08-16T14:11:32", "url": "https://files.pythonhosted.org/packages/d6/78/2cb84e6c1920f0cbcaa7cbca725a4463ff78c3eaa3d03d578570ebccd7b7/mkdocs-redirects-1.0.0.tar.gz" } ] }