{
    "info": {
        "author": "Sebastian Dahlgren",
        "author_email": "sebastian.dahlgren@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Console",
            "License :: OSI Approved :: Apache Software License",
            "Operating System :: OS Independent",
            "Programming Language :: Python"
        ],
        "description": "# markdown-docs - Documentation generator for Markdown projects\n\nmarkdown-docs is a documentation generator for projects using Markdown. The problem with having Markdown files spread around your project is that it is hard to get an overview of all your documentation. markdown-docs solves this by collecting all of your Markdown files into one browsable HTML hierarchy.\n\n## Screenshot\n\n![screenshot](https://raw.github.com/sebdah/markdown-docs/gh-pages/img/screenshot.png)\n\n## Usage\n\n### Browsing docs with the embedded web server\n\nRun the following to fire up a local web server with your documentation\n\n    cd your/project/path\n    markdown-docs\n\nor\n\n    markdown-docs serve\n\nThen point your browser to [http://localhost:5000/](http://localhost:5000/).\n\n### Generating HTML output\n\n    cd your/project/path\n    markdown-docs generate --output ~/docs\n\nIf you do not set `--output` a temporary directory will be created for you.\n\n\n## Installation\n\nThe easiest way is to install markdown-docs via `pip`\n\n    pip install markdown-docs\n\n## Features\n\n- Quick overview of all project Markdown files\n- Adding [Table of contents](http://pythonhosted.org/Markdown/extensions/toc.html)\n- [Syntax highlighting](http://pythonhosted.org/Markdown/extensions/code_hilite.html)\n- Reads title from [metadata](http://pythonhosted.org/Markdown/extensions/meta_data.html)\n- Support for the [Markdown tables extension](http://pythonhosted.org/Markdown/extensions/tables.html)\n- No Internet connection needed\n- markdown-docs comes with an embedded web server for serving static HTML locally\n\n### Metadata details\n\nmarkdown-docs is looking for Markdown meta data. Currently markdown-docs is only taking the `Title` meta data attribute in consideration. Meta data in Markdown looks like this\n\n    Title: Document title\n    Date: 2013-04-25\n\n    This is where my Markdown really starts\n\nUsing meta data in markdown-docs is optional. If the `Title` tag is there, markdown-docs will show that document title instead of the file name on the index page.\n\n### Syntax highlighting\n\nmarkdown-docs supports syntax highlighting via the `Markdown` module. You can define the programming language by adding `:::language` as in this example\n\n    :::python\n    print('This is highlighted as Python code')\n\nMore details can be found in the [module docs](http://pythonhosted.org/Markdown/extensions/code_hilite.html).\n\n### Adding Table of contents\n\nA table of contents will be automatically generated in the HTML output if markdown-docs finds a `[TOC]` tag anywhere in the Markdown.\n\n    # Table of contents\n\n    [TOC]\n\n    # My header\n\n    ## My subheader\n\nRelease information\n-------------------\n\n**0.2.0 (2013-04-26)**\n\n- First public release\n\nAuthor\n------\n\nThis project is maintained by [Sebastian Dahlgren](http://www.sebastiandahlgren.se) ([GitHub](https://github.com/sebdah) | [Twitter](https://twitter.com/sebdah) | [LinkedIn](http://www.linkedin.com/in/sebastiandahlgren))\n\nLicense\n-------\n\nAPACHE LICENSE 2.0\nCopyright 2013 Sebastian Dahlgren\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://sebdah.github.com/markdown-docs/",
        "keywords": "markdown documentation md mdown",
        "license": "Apache License, Version 2.0",
        "maintainer": null,
        "maintainer_email": null,
        "name": "markdown-docs",
        "package_url": "https://pypi.org/project/markdown-docs/",
        "platform": "Any",
        "project_url": "https://pypi.org/project/markdown-docs/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://sebdah.github.com/markdown-docs/"
        },
        "release_url": "https://pypi.org/project/markdown-docs/0.2.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Documentation generator for Markdown projects",
        "version": "0.2.0"
    },
    "last_serial": 794521,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "528f821f5daa242ae9c65149b148eaff",
                    "sha256": "afa429a4291689e68d2083e31702ff9b69e3a7304d317f1048a5b6df02bf0320"
                },
                "downloads": -1,
                "filename": "markdown-docs-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "528f821f5daa242ae9c65149b148eaff",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 46085,
                "upload_time": "2013-04-26T06:00:29",
                "url": "https://files.pythonhosted.org/packages/3d/59/bc762de38c8c6df97254d28a1009bc4ae9cc5f2a6ce2f21a0f331ff2c885/markdown-docs-0.1.0.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c13a5c05115d52655d34e52ef233258a",
                    "sha256": "f7198690834f4da46fffb50d60af5e9191168b8927935009cbc30309cb3e9f55"
                },
                "downloads": -1,
                "filename": "markdown-docs-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "c13a5c05115d52655d34e52ef233258a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 51812,
                "upload_time": "2013-04-26T17:57:42",
                "url": "https://files.pythonhosted.org/packages/85/32/a8de5d86c515da80a0aec88a73e0b97dc43ece82732ce958344ec2198d7e/markdown-docs-0.2.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c13a5c05115d52655d34e52ef233258a",
                "sha256": "f7198690834f4da46fffb50d60af5e9191168b8927935009cbc30309cb3e9f55"
            },
            "downloads": -1,
            "filename": "markdown-docs-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c13a5c05115d52655d34e52ef233258a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 51812,
            "upload_time": "2013-04-26T17:57:42",
            "url": "https://files.pythonhosted.org/packages/85/32/a8de5d86c515da80a0aec88a73e0b97dc43ece82732ce958344ec2198d7e/markdown-docs-0.2.0.tar.gz"
        }
    ]
}