mkdocs-nature


Namemkdocs-nature JSON
Version 0.6 PyPI version JSON
download
home_pagehttps://waylan.github.io/mkdocs-nature/
SummaryA MkDocs theme. A clone of the "greenish" Sphinx theme of the same name.
upload_time2023-09-14 18:22:42
maintainer
docs_urlNone
authorWaylan Limberg
requires_python
licenseBSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =============
MkDocs-Nature
=============

.. default-role:: code

A `MkDocs`_ theme. A clone of the "greenish" Sphinx theme of the same name.

For a demonstration of its `features`_ see the `documentation`_.

Installation
============

To install the MkDocs-Nature them, run the following command::

    pip install mkdocs-nature

Setup
=====

Configure your MkDocs project to use the theme by setting the ``theme.name`` to ``nature``::

    theme:
        name: nature

For a list of supported variables which can be set in the config, see the
documented `features`_.

.. _MkDocs: https://www.mkdocs.org/
.. _features: https://waylan.github.io/mkdocs-nature/features/
.. _documentation: https://waylan.github.io/mkdocs-nature/

            

Raw data

            {
    "_id": null,
    "home_page": "https://waylan.github.io/mkdocs-nature/",
    "name": "mkdocs-nature",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Waylan Limberg",
    "author_email": "waylan.limberg@icloud.com",
    "download_url": "https://files.pythonhosted.org/packages/c3/ac/3662eadd34ce4db2ae7091a464f324cbb31ceeed908a1d4f49b3f02ff16f/mkdocs-nature-0.6.tar.gz",
    "platform": null,
    "description": "=============\nMkDocs-Nature\n=============\n\n.. default-role:: code\n\nA `MkDocs`_ theme. A clone of the \"greenish\" Sphinx theme of the same name.\n\nFor a demonstration of its `features`_ see the `documentation`_.\n\nInstallation\n============\n\nTo install the MkDocs-Nature them, run the following command::\n\n    pip install mkdocs-nature\n\nSetup\n=====\n\nConfigure your MkDocs project to use the theme by setting the ``theme.name`` to ``nature``::\n\n    theme:\n        name: nature\n\nFor a list of supported variables which can be set in the config, see the\ndocumented `features`_.\n\n.. _MkDocs: https://www.mkdocs.org/\n.. _features: https://waylan.github.io/mkdocs-nature/features/\n.. _documentation: https://waylan.github.io/mkdocs-nature/\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "A MkDocs theme. A clone of the \"greenish\" Sphinx theme of the same name.",
    "version": "0.6",
    "project_urls": {
        "Homepage": "https://waylan.github.io/mkdocs-nature/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0ed5df4c68cc22a42e188ca3371a0e39db8bd2ed9641f02d56e13bd461c40286",
                "md5": "a37244b6b9631a027f46ba7c9c2ca13b",
                "sha256": "e9705009cf0bb1bb6b81ffe907336ac3903779f541f86dfbf01eff4734dc4f39"
            },
            "downloads": -1,
            "filename": "mkdocs_nature-0.6-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a37244b6b9631a027f46ba7c9c2ca13b",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 55169,
            "upload_time": "2023-09-14T18:22:40",
            "upload_time_iso_8601": "2023-09-14T18:22:40.815163Z",
            "url": "https://files.pythonhosted.org/packages/0e/d5/df4c68cc22a42e188ca3371a0e39db8bd2ed9641f02d56e13bd461c40286/mkdocs_nature-0.6-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c3ac3662eadd34ce4db2ae7091a464f324cbb31ceeed908a1d4f49b3f02ff16f",
                "md5": "0fc10985e2fe1d5245f1ce0a266d51d7",
                "sha256": "688dd40893e9b87bd42aaea441f77faae34a8ba171b712f942787dfc6ec2e0d0"
            },
            "downloads": -1,
            "filename": "mkdocs-nature-0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "0fc10985e2fe1d5245f1ce0a266d51d7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 52676,
            "upload_time": "2023-09-14T18:22:42",
            "upload_time_iso_8601": "2023-09-14T18:22:42.416368Z",
            "url": "https://files.pythonhosted.org/packages/c3/ac/3662eadd34ce4db2ae7091a464f324cbb31ceeed908a1d4f49b3f02ff16f/mkdocs-nature-0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-14 18:22:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mkdocs-nature"
}
        
Elapsed time: 0.10509s