{ "info": { "author": "Dave Hein", "author_email": "dhein@acm.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Topic :: Text Processing :: Markup" ], "description": "MarkdownTools2\n==============\n\nMarkdownTools is a collection of command line utilities for processing \nMarkdown text files. At the moment the collection includes only one \nutility: ``mdmerge``. Over time additional utilities will be added to \nsupport Markdown workflows. \n\n**Note:** if you are using Python 3, then you need the \n``MarkdownTools`` package.\n\nmdmerge\n=======\n\n``mdmerge`` is a command line utility that produces a single Markdown document\nby merging a set of Markdown documents. The merge can be accomplished by \nexpanding *include* declarations found in the input files, by concatenating\na list of files found in an index file, or both.\n\nWait, doesn't Marked 2 already do that?\n---------------------------------------\n\nBrett Terpstra's `Marked 2`_ application is a GUI product that runs on OS X;\nit watches Markdown text and displays the formatted output; it has \nextensive support for multi-file Markdown documents.\n*Marked* is my tool of \nchoice for viewing formatted Markdown. I use it whenever I'm creating or \nreviewing Markdown content on my OS X machine.\nThe invaluable multi-file document support in *Marked* is what drove me to\ncreate ``mdmerge``.\n\n.. _Marked 2: http://marked2app.com\n\n``mdmerge`` brings multi-file Markdown document processing to the command line.\nIt is useful in any automated scripting environment where Markdown is\nprocessed. For example, I use it in automated build scripts \n(e.g., using gmake or Grunt) to produce documentation for the\nsoftware I'm building.\nIt is cross-platform; you can pre-process the \nMarkdown files on any common OS that has a recent version of Python.\n\nWhat kinds of Markdown does it work with?\n-----------------------------------------\n\n``mdmerge`` has been tested with documents containing these Markdown syntax\nvariants:\n\n* classic (John Gruber's Markdown_ syntax)\n* MultiMarkdown (Fletcher Penny's syntax, MultiMarkdown_ version 4)\n* GHF (`GitHub Flavored Markdown`_)\n\n.. _Markdown:\n\thttp://daringfireball.net/projects/markdown/syntax\n.. _MultiMarkdown: http://fletcherpenney.net/multimarkdown/\n.. _GitHub Flavored Markdown:\n\thttps://help.github.com/articles/github-flavored-markdown\n\nHow do files get included?\n--------------------------\n\n``mdmerge`` accepts include declarations in these styles:\n\n* MultiMarkdown transclusions_\n* `Marked file includes`_\n* `LeanPub code includes`_ (as `interpreted by Marked`_)\n* `LeanPub index files`_ (also known as *book* files)\n* `mmd_merge index files`_\n\n.. _Marked file includes: \n\thttp://marked2app.com/help/Multi-File_Documents.html\n.. _interpreted by Marked: \n\thttp://marked2app.com/help/Special_Syntax.html#includingcode\n.. _LeanPub code includes: \n\thttps://leanpub.com/help/manual#leanpub-auto-code\n.. _LeanPub index files: \n\thttps://leanpub.com/help/manual#leanpub-auto-the-booktxt-file\n.. _transclusions: \n\thttp://fletcher.github.io/MultiMarkdown-4/transclusion\n.. _mmd_merge index files: \n\thttps://github.com/fletcher/MMD-Support/blob/master/Utilities/mmd_merge.pl\n\nIncludes can be nested; that is, a file can include another file that itself\ninclude other files, and so on. Index (or book) files are only processed\nas such when they are the primary input; they cannot be nested -- files \nlisted in the index file are treated as normal input files (including\nexpanding include specifications found within).\n\nCommand Line Syntax\n===================\n\nThe command line looks like this:\n\n::\n\n\tmdmerge [options] [-o outputfile] inputfiles\n\tmdmerge [options] [-o outputfile] -\n\nOptions\n-------\n\n``options``\n\tOne or more of `--book`, `--export-target`, `--ignore-transclusions`,\n\t`--just-raw`, `--leanpub`, `--version`, `--help`, `-h`.\n\n``--book``\n\tTreat STDIN as an index file (a \"book\" file).\n\n``--export-target [html|latex|lyx|opml|rtf|odf]``\n\tIndicates the ultimate output target of the markdown processor, but \n\tprimarily impacts wildcard substitution in Marked inclusion.\n\n``--help``\n\tHelp information\n\n``-h``\n\tHelp information\n\t\n``--ignore-transclusions``\n\tLeave any MultiMarkdown transclusion specifications alone; do not include\n\tthe specified file. Useful if you want to mix Marked/LeanPub includes and\n\tMultiMarkdown includes, but have MultiMarkdown handline the transclusions.\n\n``--just-raw``\n\tIgnore all include specifications except for raw includes; useful for\n\tprocessing the output of the Markdown processor to pick up the raw file include\n\tspecifications that should have passed through untouched.\n\n``--leanpub``\n\tIndicates that any input file named `book.txt` should be treated as a\n\tLeanPub index file.\n\n``--version``\n\tGives the version information about the utility.\n\n``-o outputfile``\n\tThe filepath in which to store the merged text. If not specified, then \n\tSTDOUT is used.\n\n``--outfile outputfile``\n\tsame as `-o`.\n\n``inputfiles``\n\tA list of space separated input files that can be merged together. If\n\tmultiple files are given, they are treated as if they were specified \n\tin a LeanPub index file.\n\n``-``\n\tThe input comes from STDIN.\n\n\nInstallation\n============\n\n**Note:** Requires Python 2.6 or later. For Python 3 environments use\nthe **MarkdownTools** package.\n\nInstall with::\n\n\tpip install MarkdownTools2\n\nThis will create the command ``mdmerge``. Use ``mdmerge --version`` and \n``mdmerge --help`` to confirm the installation.\n\nFor developers\n==============\n\nLicense and Copyright\n---------------------\n\nMarkdownTools is licensed with the `Mozilla Public License`_ Version 2.0. \n\nCopyright 2014 Dave Hein\n\n.. _Mozilla Public License: http://www.mozilla.org/MPL/2.0/\n\nSource code\n-----------\n\nThe source for this project can be found on GitHub at:\n\nhttps://github.com/JeNeSuisPasDave/MarkdownTools", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/JeNeSuisPasDave/MarkdownTools", "keywords": "markdown text development", "license": "MPL-2.0", "maintainer": null, "maintainer_email": null, "name": "MarkdownTools2", "package_url": "https://pypi.org/project/MarkdownTools2/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/MarkdownTools2/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/JeNeSuisPasDave/MarkdownTools" }, "release_url": "https://pypi.org/project/MarkdownTools2/1.0.1/", "requires_dist": null, "requires_python": null, "summary": "Markdown processing tools, including mdmerge", "version": "1.0.1" }, "last_serial": 1531831, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "09cb4fe8dc7f6abcfc65048c40346306", "sha256": "0fb18cc9b3e4659831d1a8164ff14ac7ae0f3f34fb4da366a4ae97abc3ded7fe" }, "downloads": -1, "filename": "MarkdownTools2-1.0.tar.gz", "has_sig": false, "md5_digest": "09cb4fe8dc7f6abcfc65048c40346306", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28356, "upload_time": "2014-03-31T01:32:52", "url": "https://files.pythonhosted.org/packages/f9/2e/f10dd46a4e69403ab84ba1743f52417b2d9e111101b920f5679c45f7a4f4/MarkdownTools2-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "105b5afbc84feb7191929dd6ac17e120", "sha256": "75d63c20339b4d69886ab523db94a1d4bd42f35943e305dbb3dba810ac4fbf54" }, "downloads": -1, "filename": "MarkdownTools2-1.0.1.tar.gz", "has_sig": false, "md5_digest": "105b5afbc84feb7191929dd6ac17e120", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29231, "upload_time": "2015-05-03T21:09:43", "url": "https://files.pythonhosted.org/packages/be/2c/ab07120fa88c1624dba35e706326a30a62b025cd0c2f514b2ad673de8160/MarkdownTools2-1.0.1.tar.gz" } ], "1.0rc1": [ { "comment_text": "", "digests": { "md5": "f79bb0b07e0ac6091a9903afc6ddb5e3", "sha256": "798655032b1597b76dca9b98c93867a61dfbcdc325fdf952be0f49b9e518a683" }, "downloads": -1, "filename": "MarkdownTools2-1.0rc1.tar.gz", "has_sig": false, "md5_digest": "f79bb0b07e0ac6091a9903afc6ddb5e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26019, "upload_time": "2014-03-15T17:36:55", "url": "https://files.pythonhosted.org/packages/82/fc/bed074cd9567a87588de2007987342a23de5a89487e5640b714e2223ea89/MarkdownTools2-1.0rc1.tar.gz" } ], "1.0rc2": [ { "comment_text": "", "digests": { "md5": "24310beedf9633dce7664592b0a51758", "sha256": "c1d326ad5a321d7b38c009d082dd7aad80ce3e49eb23d00f59cee267c9fdb75e" }, "downloads": -1, "filename": "MarkdownTools2-1.0rc2.tar.gz", "has_sig": false, "md5_digest": "24310beedf9633dce7664592b0a51758", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26940, "upload_time": "2014-03-20T04:46:09", "url": "https://files.pythonhosted.org/packages/f4/e4/ba07b92e283f61200185b4f477f08a4c2bd174e987cf5cccdb073ea3ee05/MarkdownTools2-1.0rc2.tar.gz" } ], "1.0rc3": [ { "comment_text": "", "digests": { "md5": "6414a37d5193aa9f41b502e0d98af094", "sha256": "e5fcb63ab62ed850b3d0d56477c347dfda0432cb8a224a8e91663d25bf281ac0" }, "downloads": -1, "filename": "MarkdownTools2-1.0rc3.tar.gz", "has_sig": false, "md5_digest": "6414a37d5193aa9f41b502e0d98af094", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26940, "upload_time": "2014-03-23T18:40:07", "url": "https://files.pythonhosted.org/packages/fa/53/7486e12ec1572f1b8deff5c8b02d8381bb71da9d36c372f352d6aef9227c/MarkdownTools2-1.0rc3.tar.gz" } ], "1.0rc4": [ { "comment_text": "", "digests": { "md5": "2f23ae6f14ebf80e571b716523a22f8b", "sha256": "190df77e45a2f1e41e2753e145ffc1dcd20ffa44b618950e8a8d278e109c77e5" }, "downloads": -1, "filename": "MarkdownTools2-1.0rc4.tar.gz", "has_sig": false, "md5_digest": "2f23ae6f14ebf80e571b716523a22f8b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27002, "upload_time": "2014-03-25T03:08:49", "url": "https://files.pythonhosted.org/packages/7d/56/3bb822e6459443981bf29e65e151cc1a896cc1867fd00774b2e70e06d0e3/MarkdownTools2-1.0rc4.tar.gz" } ], "1.0rc5": [ { "comment_text": "", "digests": { "md5": "d8ae4288ca5b8ca6b7c30e8fc799d2aa", "sha256": "c41c47e9fcfba9cfae82de079fe9679b273e7e1df9a9dad57647adda52f402b7" }, "downloads": -1, "filename": "MarkdownTools2-1.0rc5.tar.gz", "has_sig": false, "md5_digest": "d8ae4288ca5b8ca6b7c30e8fc799d2aa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28326, "upload_time": "2014-03-30T16:59:14", "url": "https://files.pythonhosted.org/packages/a2/e5/75d90b46bdb1c36026858beed7cc2fa55a699d88ca96a9a7980ff90e14b4/MarkdownTools2-1.0rc5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "105b5afbc84feb7191929dd6ac17e120", "sha256": "75d63c20339b4d69886ab523db94a1d4bd42f35943e305dbb3dba810ac4fbf54" }, "downloads": -1, "filename": "MarkdownTools2-1.0.1.tar.gz", "has_sig": false, "md5_digest": "105b5afbc84feb7191929dd6ac17e120", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29231, "upload_time": "2015-05-03T21:09:43", "url": "https://files.pythonhosted.org/packages/be/2c/ab07120fa88c1624dba35e706326a30a62b025cd0c2f514b2ad673de8160/MarkdownTools2-1.0.1.tar.gz" } ] }