{ "info": { "author": "Jesse Dhillon", "author_email": "jesse@dhillon.com", "bugtrack_url": null, "classifiers": [ "Programming Language :: Python" ], "description": "============\nmdx_sections\n============\n\nOverview\n========\n\nThis module is an extension to `Python-Markdown `_ which provides the ability to add a small amount of structure to your Markdown documents.\n\nThere are two premises underlying the operation of this extension:\n\n- Each heading element indicates the start of a new document section.\n- Document sections can be nested, and the parent of a document section is the section created by the first preceding heading element with a higher order *e.g.* an ``h2`` section is contained by the heading block appearing prior to it which corresponds to an ``h1``. If there is no such element, then it is a child of the root element.\n\nThe new section (a containing ``div`` element) can be configured to have an specific ``id`` and ``class`` attribute. The syntax is::\n\n # {id,class} Title\n\nBoth ``id`` and ``class`` are optional, the contaaining ``div`` element will always be created as long as this extension is enabled.\n\nOne example should make this clear. Suppose the following input document is provided::\n \n # {resume} Resumé\n \n ## {education} Education\n Educational experience\n \n ## {experience} Working Experience\n Work experience\n \n ### {xyz_corp,employer} XYZ Corp.\n I worked at XYZ\n \n ### {acme_inc,employer} Acme Inc.\n I also worked at Acme\n \n ## Hobbies\n - Cards\n - Books\n - Dogs\n \n ### About _my_ hobbies\n My hobbies are great.\n\nThis would transform to become::\n\n
\n

Resumé

\n
\n

Education

\n

Educational experience

\n
\n
\n

Working Experience

\n

Work experience

\n
\n

XYZ Corp.

\n

I worked at XYZ

\n
\n
\n

Acme Inc.

\n

I also worked at Acme

\n
\n
\n
\n

Hobbies

\n
    \n
  • Cards
  • \n
  • Books
  • \n
  • Dogs
  • \n
\n
\n

About my hobbies

\n

My hobbies are great.

\n
\n
\n
\n\nThe resulting document is, IMO, semantically correct. It's also easier to style with CSS.\n\nInstallation\n============\n\nInstall using setuptools, e.g. (within a virtualenv)::\n\n $ pip install mdx_sections\n\nOr if you prefer to get the latest from Github::\n\n $ git clone git://github.com/jessedhillon/mdx_sections.git\n\nUsage\n=====\n\nFor an extended introduction to Python-Markdown extensions, see `the documentation http://freewisdom.org/projects/python-markdown/Extensions`.\n\nThis extension is available by the short name of ``sections``, and it has two config parameters:\n\n- ``section_cls``, defaults to ``section``. This is the default CSS class applied to a generated ``div``, when the Markdown document does not specify one.\n- ``heading_cls``, defaults to ``title``. This is the default CSS class applied to the ``h[1-6]`` element which is being transformed.\n\n\n=======\nChanges\n=======\n\n0.1\n=======\n*22 Feb 2012*\n\n- Initial public release.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/jessedhillon/mdx_sections", "keywords": "web wsgi bfg pylons pyramid", "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "mdx_sections", "package_url": "https://pypi.org/project/mdx_sections/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/mdx_sections/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/jessedhillon/mdx_sections" }, "release_url": "https://pypi.org/project/mdx_sections/0.1/", "requires_dist": null, "requires_python": null, "summary": "Python-Markdown extension to add a small amount of structure to Markdown documents.", "version": "0.1" }, "last_serial": 794600, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "8e9565fcb13a17172f41c65ff5c2a79c", "sha256": "be60a80d51a380b9583b345543b3897a67e4332473730ba9096c1b929aa47567" }, "downloads": -1, "filename": "mdx_sections-0.1.tar.gz", "has_sig": false, "md5_digest": "8e9565fcb13a17172f41c65ff5c2a79c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4137, "upload_time": "2012-02-22T11:02:44", "url": "https://files.pythonhosted.org/packages/72/a7/5c29f8d63ae5aaa9cf5a848022299c4a4436b1c8699c866646974dd05e6e/mdx_sections-0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8e9565fcb13a17172f41c65ff5c2a79c", "sha256": "be60a80d51a380b9583b345543b3897a67e4332473730ba9096c1b929aa47567" }, "downloads": -1, "filename": "mdx_sections-0.1.tar.gz", "has_sig": false, "md5_digest": "8e9565fcb13a17172f41c65ff5c2a79c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4137, "upload_time": "2012-02-22T11:02:44", "url": "https://files.pythonhosted.org/packages/72/a7/5c29f8d63ae5aaa9cf5a848022299c4a4436b1c8699c866646974dd05e6e/mdx_sections-0.1.tar.gz" } ] }