{
    "info": {
        "author": "Konstantin Molchanov",
        "author_email": "moigagoo@live.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": "# MkDocs Backend for Foliant\n\nMkDocs backend lets you build websites from Foliant projects using [MkDocs](https://mkdocs.org) static site generator.\n\nThe backend adds three targets: `mkdocs`, `site`, and `ghp`. The first one converts a Foliant project into a MkDocs project without building any html files. The second one builds a standalone website. The last one deploys the website to GitHub Pages.\n\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.mkdocs\n```\n\n\n## Usage\n\nConvert Foliant project to MkDocs:\n\n```bash\n$ foliant make mkdocs -p my-project\n\u2714 Parsing config\n\u2714 Applying preprocessor mkdocs\n\u2714 Making mkdocs with MkDocs\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nResult: My_Project-2017-12-04.mkdocs.src\n```\n\nBuild a standalone website:\n\n```bash\n$ foliant make site -p my-project\n\u2714 Parsing config\n\u2714 Applying preprocessor mkdocs\n\u2714 Making site with MkDocs\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nResult: My_Project-2017-12-04.mkdocs\n```\n\nDeploy to GitHub Pages:\n\n```bash\n$ foliant make ghp -p my-project\n\u2714 Parsing config\n\u2714 Applying preprocessor mkdocs\n\u2714 Making ghp with MkDocs\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nResult: https://account-name.github.io/my-project/\n```\n\n\n## Config\n\nYou don't have to put anything in the config to use MkDocs backend. If it's installed, Foliant detects it.\n\nTo customize the output, use options in `backend_config.mkdocs` section:\n\n```yaml\nbackend_config:\n  mkdocs:\n    mkdocs_path: mkdocs\n    slug: my_awesome_project\n    use_title: true\n    use_chapters: true\n    use_headings: true\n    default_subsection_title: Expand\n    mkdocs.yml:\n      site_name: Custom Title\n      site_url: http://example.com\n      site_author: John Smith\n```\n\n`mkdocs_path`\n:   Path to the MkDocs executable. By default, `mkdocs` command is run, which implies it's somewhere in your `PATH`.\n\n`slug`\n:   Result directory name without suffix (e.g. `.mkdocs`). Overrides top-level config option `slug`.\n\n`use_title`\n:   If `true`, use `title` value from `foliant.yml` as `site_name` in `mkdocs.yml`. It this case, you don't have to specify `site_name` in `mkdocs.yml` section. If you do, the value from `mkdocs.yml` section has higher priority.\n\n    If `false`, you *must* specify `site_name` manually, otherwise MkDocs will not be able to build the site.\n\n    Default is `true`.\n\n`use_chapters`\n:   Similar to `use_title`, but for `pages`. If `true`, `chapters` value from `foliant.yml` is used as `pages` in `mkdocs.yml`.\n\n`use_headings`\n:   If `true`, the resulting data of `pages` section in `mkdocs.yml` will be updated with the content of top-level headings of source Markdown files.\n\n`default_subsection_title`\n:   Default title of a subsection, i.e. a group of nested chapters, in case the title is specified as an empty string. If `default_subsection_title` is not set in the config, **\u2026** will be used.\n\n`mkdocs.yml`\n:   Params to be copied into `mkdocs.yml` file. The params are passed \u201cas is,\u201d so you should consult with the [MkDocs configuration docs](http://www.mkdocs.org/user-guide/configuration/).\n\n\n## Preprocessor\n\nMkDocs backend ships with a preprocessor that transforms a Foliant project into a MkDocs one. Basically, `foliant make mkdocs` just applies the preprocessor.\n\nThe preprocessor is invoked automatically when you run MkDocs backend, so you don't have to add it in `preprocessors` section manually.\n\nHowever, it's just a regular preprocessor like any other, so you can call it manually if necessary:\n\n```yaml\npreprocessors:\n  - mkdocs:\n      mkdocs_project_dir_name: mkdocs\n```\n\n`mkdocs_project_dir_name`\n:   Name of the directory for the generated MkDocs project within the tmp directory.\n\n\n## Troubleshooting\n\n### Fenced Code Is Not Rendered in List Items or Blockquotes\n\nMkDocs can't handle fenced code blocks in blockquotes or list items due to an [issue in Python Markdown](https://github.com/Python-Markdown/markdown/issues/53).\n\nUnfortunately, nothing can be done about it, either on MkDocs's or Foliant's part. As a workaround, use [indented code blocks](https://daringfireball.net/projects/markdown/syntax#precode).\n\n\n### Paragraphs Inside List Items Are Rendered on the Root Level\n\nCheck if you use **four-space indentation**. [Python Markdown is stern about this point](https://pythonhosted.org/Markdown/index.html#differences).\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.mkdocs",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "foliantcontrib.mkdocs",
        "package_url": "https://pypi.org/project/foliantcontrib.mkdocs/",
        "platform": "any",
        "project_url": "https://pypi.org/project/foliantcontrib.mkdocs/",
        "project_urls": {
            "Homepage": "https://github.com/foliant-docs/foliantcontrib.mkdocs"
        },
        "release_url": "https://pypi.org/project/foliantcontrib.mkdocs/1.0.10/",
        "requires_dist": [
            "foliant (>=1.0.8)",
            "mkdocs (>=1.0.4)"
        ],
        "requires_python": "",
        "summary": "MkDocs backend for Foliant documentation generator.",
        "version": "1.0.10"
    },
    "last_serial": 5731330,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d7d10f65bde07314d0855724e427cefe",
                    "sha256": "b3635a3531decdb5ae229534cb06f6df7f70f4ca2f17b8764d2772f836f4b93f"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d7d10f65bde07314d0855724e427cefe",
                "packagetype": "bdist_wheel",
                "python_version": "3.6",
                "requires_python": null,
                "size": 7522,
                "upload_time": "2017-12-14T11:23:52",
                "url": "https://files.pythonhosted.org/packages/a3/ff/7390d34857ca05c28ad5f7f8bbb90abd80a2d5a1535defcaf201396835bf/foliantcontrib.mkdocs-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "604db09d4aaf6a3c65ff64b1a8011fcc",
                    "sha256": "cbddaa351a714d42d3479f254f88a7dd49a4f7b2abe9cebc50b4e28759c85bc2"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "604db09d4aaf6a3c65ff64b1a8011fcc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4776,
                "upload_time": "2017-12-14T11:23:53",
                "url": "https://files.pythonhosted.org/packages/d9/f5/55d74e89215f0a0a06cc23568a6d626800194561f00e6dc0bd5490467e83/foliantcontrib.mkdocs-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a6638a9b9fbcd133e4de55bc94ac580a",
                    "sha256": "73d0cac3823e699377d6d503e4825b1ba74b4bd92896b8e6105ed1deddff217a"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a6638a9b9fbcd133e4de55bc94ac580a",
                "packagetype": "bdist_wheel",
                "python_version": "3.6",
                "requires_python": null,
                "size": 7805,
                "upload_time": "2017-12-16T18:56:01",
                "url": "https://files.pythonhosted.org/packages/a5/b3/26bcdc8a02f8c9ba774a07277c1fa0e2e700e2150bea1a67b17e83099e59/foliantcontrib.mkdocs-1.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6cbe1484dcb60545ed1e2c558fdcf4a5",
                    "sha256": "ff1e5b9ca46569e32ed87f1dceca9668abdf801bd2fba7e37675f2d3d607c14b"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6cbe1484dcb60545ed1e2c558fdcf4a5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4958,
                "upload_time": "2017-12-16T18:56:04",
                "url": "https://files.pythonhosted.org/packages/07/f1/4bed82bf149919923dc20ee500732e50f3a36e1f4dc31ff859aadad241fe/foliantcontrib.mkdocs-1.0.1.tar.gz"
            }
        ],
        "1.0.10": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b1b00bf747f64ef48e63779467f5a8e6",
                    "sha256": "053918319401ac34f83b021e41e1bc10e2b33d6e73e87fdc73922fe9dcadae76"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.10-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b1b00bf747f64ef48e63779467f5a8e6",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 7613,
                "upload_time": "2019-08-26T14:52:25",
                "url": "https://files.pythonhosted.org/packages/22/c1/809eb900198a9120229cfcd83ec16fa1336b77fbb3d62f2e6644fcaf0888/foliantcontrib.mkdocs-1.0.10-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "7bd035ac266f712d74207f77f4b9e0af",
                    "sha256": "017b7b929b33f962d0697965779a200116c54231a29e85442637fe041578f0df"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.10.tar.gz",
                "has_sig": false,
                "md5_digest": "7bd035ac266f712d74207f77f4b9e0af",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6349,
                "upload_time": "2019-08-26T14:52:27",
                "url": "https://files.pythonhosted.org/packages/9a/02/4b5bf7d662247cfb52250008fbca33f0d18c76a953b6f31a942275ee2abd/foliantcontrib.mkdocs-1.0.10.tar.gz"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fa1463c4ec8ce27653a20bbbfb55e6d5",
                    "sha256": "c37ee140f813174f57e195431dfb446c32e7db0814c5340611667109aaf46923"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "fa1463c4ec8ce27653a20bbbfb55e6d5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8634,
                "upload_time": "2018-03-21T18:24:45",
                "url": "https://files.pythonhosted.org/packages/13/82/5131b6bde7cc7b3988a97382e97e9b0960d8af53e6134e8f74dd08a82382/foliantcontrib.mkdocs-1.0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "07ef42a9f3797bfd84be713e417bc3de",
                    "sha256": "22efbe4e1754a6c32f8fb08c5e4dca03632334827ec7c67fffeac426d457f8f3"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "07ef42a9f3797bfd84be713e417bc3de",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5609,
                "upload_time": "2018-03-21T18:24:46",
                "url": "https://files.pythonhosted.org/packages/19/19/374b3bf29bb7468a45c96603f8b29dfe05209b1396e171574e4bcfe18e04/foliantcontrib.mkdocs-1.0.2.tar.gz"
            }
        ],
        "1.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "efa72e751bad375860e8430039aaaa9d",
                    "sha256": "57f6df3f74b915b7caf00d1d946da0cf7b5c23435e981b8a76cb25aea6c837a6"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "efa72e751bad375860e8430039aaaa9d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6422,
                "upload_time": "2018-04-20T10:17:17",
                "url": "https://files.pythonhosted.org/packages/f9/35/3e665d2d81f03cba4147633c054c643c72c2ccda8dc1443304ebbb2a1c7c/foliantcontrib.mkdocs-1.0.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2e5a0876ac80e1341243642a50c0dc5f",
                    "sha256": "84a05cfd0a5118889a4b36f4926e345209a13baf4562d1b65e9599dbdd64a819"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "2e5a0876ac80e1341243642a50c0dc5f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6033,
                "upload_time": "2018-04-20T10:17:19",
                "url": "https://files.pythonhosted.org/packages/0d/87/fe52bee028ce11a29f15b947696d690cca51e9cbdcbebc5676d9e9a8f477/foliantcontrib.mkdocs-1.0.3.tar.gz"
            }
        ],
        "1.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "527e35350e4052bf29e166ad59505045",
                    "sha256": "06610729886d59d0a488f0bcb87978be929db5ad37c411c514c47585f4225c16"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "527e35350e4052bf29e166ad59505045",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6127,
                "upload_time": "2018-08-31T11:10:44",
                "url": "https://files.pythonhosted.org/packages/16/c4/419c894f367fb521746aaf89e9370eb801d60109d20af807cd3a923cf4e5/foliantcontrib.mkdocs-1.0.4.tar.gz"
            }
        ],
        "1.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5b40b69c9825296c52a86f2457e0db55",
                    "sha256": "246f01011e7e8c17e477202c7df2dbdc958f13db36d62f8a96f922d06c006cd6"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "5b40b69c9825296c52a86f2457e0db55",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6130,
                "upload_time": "2018-10-11T14:07:50",
                "url": "https://files.pythonhosted.org/packages/d1/29/9df615864d13e75b353c49999a3653352f25b40ff125dcb529307a81e759/foliantcontrib.mkdocs-1.0.5.tar.gz"
            }
        ],
        "1.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2adeda15332c659df753de9352b98ecd",
                    "sha256": "d38e791145200ff4018a6ae25e76a0c4576b3f0482c90656f32c39390bfd4f57"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "2adeda15332c659df753de9352b98ecd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6154,
                "upload_time": "2018-11-14T13:15:05",
                "url": "https://files.pythonhosted.org/packages/e4/90/7c17f1e5dd902ff4ee2b84e6f20bcf66769a325e2e70f9e2df766df12858/foliantcontrib.mkdocs-1.0.6.tar.gz"
            }
        ],
        "1.0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "667fee0612a4674c0c8b908d9849e47e",
                    "sha256": "15ed690420ab0e3f230da6469b86949b5e045ab4b68a92580ab63c80b23810b1"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.7.tar.gz",
                "has_sig": false,
                "md5_digest": "667fee0612a4674c0c8b908d9849e47e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6167,
                "upload_time": "2018-11-14T18:08:44",
                "url": "https://files.pythonhosted.org/packages/7e/c0/4c6ec6b97e38ff3d78779c609d533b08dcc00be3604fee2142495128a91d/foliantcontrib.mkdocs-1.0.7.tar.gz"
            }
        ],
        "1.0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f2d3aaf6e0625a136988e04b237b7c7",
                    "sha256": "cd5f086ed5a945deae68073364a3c81fb3e8956b408b5c20cf343e95bad1eee8"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.8.tar.gz",
                "has_sig": false,
                "md5_digest": "8f2d3aaf6e0625a136988e04b237b7c7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6354,
                "upload_time": "2019-04-10T15:43:11",
                "url": "https://files.pythonhosted.org/packages/dc/53/5435f6a12ba8bcb50fe33897540a004eac2830f60b7432f9984670cdaffe/foliantcontrib.mkdocs-1.0.8.tar.gz"
            }
        ],
        "1.0.9": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "88905d5a8bb2406e4b6495f44f184b63",
                    "sha256": "dbfb1a6cfd75cabb1191620a95b18df7308dffdecd9331eb9e1b7cd7ef8d5dd8"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.9-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "88905d5a8bb2406e4b6495f44f184b63",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 7603,
                "upload_time": "2019-08-23T12:10:31",
                "url": "https://files.pythonhosted.org/packages/37/a7/f65b0598c5ffbe644e786943995ad010dc63f7a8744ca6234628509cad3f/foliantcontrib.mkdocs-1.0.9-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d9d3295d44eb0ebc069c4c80a6715c91",
                    "sha256": "7a6dc38e7413f92df8889388b4e2c741e6c539b6ca468cc8169f53330f4dc067"
                },
                "downloads": -1,
                "filename": "foliantcontrib.mkdocs-1.0.9.tar.gz",
                "has_sig": false,
                "md5_digest": "d9d3295d44eb0ebc069c4c80a6715c91",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6342,
                "upload_time": "2019-08-23T12:10:32",
                "url": "https://files.pythonhosted.org/packages/77/89/68218538b2b23c8366f283472f189b210b15809f8369cc3f7005a0ad64a8/foliantcontrib.mkdocs-1.0.9.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b1b00bf747f64ef48e63779467f5a8e6",
                "sha256": "053918319401ac34f83b021e41e1bc10e2b33d6e73e87fdc73922fe9dcadae76"
            },
            "downloads": -1,
            "filename": "foliantcontrib.mkdocs-1.0.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b1b00bf747f64ef48e63779467f5a8e6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7613,
            "upload_time": "2019-08-26T14:52:25",
            "url": "https://files.pythonhosted.org/packages/22/c1/809eb900198a9120229cfcd83ec16fa1336b77fbb3d62f2e6644fcaf0888/foliantcontrib.mkdocs-1.0.10-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "7bd035ac266f712d74207f77f4b9e0af",
                "sha256": "017b7b929b33f962d0697965779a200116c54231a29e85442637fe041578f0df"
            },
            "downloads": -1,
            "filename": "foliantcontrib.mkdocs-1.0.10.tar.gz",
            "has_sig": false,
            "md5_digest": "7bd035ac266f712d74207f77f4b9e0af",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6349,
            "upload_time": "2019-08-26T14:52:27",
            "url": "https://files.pythonhosted.org/packages/9a/02/4b5bf7d662247cfb52250008fbca33f0d18c76a953b6f31a942275ee2abd/foliantcontrib.mkdocs-1.0.10.tar.gz"
        }
    ]
}