{ "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 :: 3", "Programming Language :: Python :: 3.3", "Topic :: Text Processing :: Markup" ], "description": "MarkdownTools\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 2, then you need the \n``MarkdownTools2`` 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 3.3 or later. For Python 2 environments use\nthe **MarkdownTools2** package.\n\nInstall with::\n\n\tpip install MarkdownTools\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 2015 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": "MarkdownTools", "package_url": "https://pypi.org/project/MarkdownTools/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/MarkdownTools/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/JeNeSuisPasDave/MarkdownTools" }, "release_url": "https://pypi.org/project/MarkdownTools/1.0.1/", "requires_dist": null, "requires_python": null, "summary": "Markdown processing tools, including mdmerge", "version": "1.0.1" }, "last_serial": 1531827, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "e3929c05a6c35afe4a4a73591bfbf4a3", "sha256": "d194c22062f5cf2bc407e08105b67bd06d1ee17d5e5bc5fb30cd2590d60c5f8b" }, "downloads": -1, "filename": "MarkdownTools-1.0.tar.gz", "has_sig": false, "md5_digest": "e3929c05a6c35afe4a4a73591bfbf4a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28267, "upload_time": "2014-03-31T01:33:38", "url": "https://files.pythonhosted.org/packages/43/db/93f81f8ddcd5ebae53b8f8d7375a5c5e49185800459ad188fae13783f3f8/MarkdownTools-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "9d3c0e6a62050718c2f8fec4b225de19", "sha256": "8e058361ab789ba6672a0a558a830a5e6b5a5a72242a9df17b72c4d3c6e06757" }, "downloads": -1, "filename": "MarkdownTools-1.0.1.tar.gz", "has_sig": false, "md5_digest": "9d3c0e6a62050718c2f8fec4b225de19", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29139, "upload_time": "2015-05-03T21:01:59", "url": "https://files.pythonhosted.org/packages/80/3f/056bc7e7c0c8fbff92dd9c0a92eed40dd633f8a4698ba8aa5570829e940a/MarkdownTools-1.0.1.tar.gz" } ], "1.0rc1": [ { "comment_text": "", "digests": { "md5": "6d10f1c638aecf07ed16650cca5940ed", "sha256": "6561183cbe7ab720bc81e3950ace2e2f9c196e17da6f5dcecadba4e353d34b7e" }, "downloads": -1, "filename": "MarkdownTools-1.0rc1.tar.gz", "has_sig": false, "md5_digest": "6d10f1c638aecf07ed16650cca5940ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25967, "upload_time": "2014-03-15T17:42:23", "url": "https://files.pythonhosted.org/packages/c0/71/33e19c32d9d3bf4f3cf12c2f18a6adb4d99d17049ed3499f4f53e8831573/MarkdownTools-1.0rc1.tar.gz" } ], "1.0rc2": [ { "comment_text": "", "digests": { "md5": "f0df205234c9810244f24c287c463b1e", "sha256": "de0a75513c2cb2b30098af99523d4f6748bc4c29e96e00725ce79d71de5640bf" }, "downloads": -1, "filename": "MarkdownTools-1.0rc2.tar.gz", "has_sig": false, "md5_digest": "f0df205234c9810244f24c287c463b1e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26837, "upload_time": "2014-03-20T04:44:57", "url": "https://files.pythonhosted.org/packages/15/a5/25111ed34af0d8665ea4d43d9a26ac2c64b36681be3b86661892c1e402f4/MarkdownTools-1.0rc2.tar.gz" } ], "1.0rc3": [ { "comment_text": "", "digests": { "md5": "62be193c222f3c9e483d9d9d9a329dd7", "sha256": "2c6933b9744c76f7248e2a945e6a43b3530234f712898e640e2e06869afee84f" }, "downloads": -1, "filename": "MarkdownTools-1.0rc3.tar.gz", "has_sig": false, "md5_digest": "62be193c222f3c9e483d9d9d9a329dd7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26853, "upload_time": "2014-03-23T18:40:57", "url": "https://files.pythonhosted.org/packages/8c/55/a31fc5d7bf91196e3e051e56968ab1dc058f3491509bca0c15fae7f310ce/MarkdownTools-1.0rc3.tar.gz" } ], "1.0rc4": [ { "comment_text": "", "digests": { "md5": "0154b5b0cda00630891f0f9f94eb632c", "sha256": "e60cdb077262fc847951e8d9bd93c2620ac148705680ca6c043cc7e3a3c1e71b" }, "downloads": -1, "filename": "MarkdownTools-1.0rc4.tar.gz", "has_sig": false, "md5_digest": "0154b5b0cda00630891f0f9f94eb632c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26966, "upload_time": "2014-03-25T03:08:29", "url": "https://files.pythonhosted.org/packages/0e/c3/086a28bf2d9c4d0d99f3489a21f2267adc6a681982e6d67cb5d74cddaf02/MarkdownTools-1.0rc4.tar.gz" } ], "1.0rc5": [ { "comment_text": "", "digests": { "md5": "239b563884b93377dc4b002f52ded3b1", "sha256": "d700718571a25a2eabf8642da0190ee193608b9aebbe5c5f6d2e993155725867" }, "downloads": -1, "filename": "MarkdownTools-1.0rc5.tar.gz", "has_sig": false, "md5_digest": "239b563884b93377dc4b002f52ded3b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28238, "upload_time": "2014-03-30T16:58:47", "url": "https://files.pythonhosted.org/packages/02/1b/01a5e6a6ebbb33649c4a9ed8bb40b92f6ddf633a28e3dc7ad240348b77e7/MarkdownTools-1.0rc5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9d3c0e6a62050718c2f8fec4b225de19", "sha256": "8e058361ab789ba6672a0a558a830a5e6b5a5a72242a9df17b72c4d3c6e06757" }, "downloads": -1, "filename": "MarkdownTools-1.0.1.tar.gz", "has_sig": false, "md5_digest": "9d3c0e6a62050718c2f8fec4b225de19", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29139, "upload_time": "2015-05-03T21:01:59", "url": "https://files.pythonhosted.org/packages/80/3f/056bc7e7c0c8fbff92dd9c0a92eed40dd633f8a4698ba8aa5570829e940a/MarkdownTools-1.0.1.tar.gz" } ] }