{ "info": { "author": "Franco Masotti", "author_email": "franco.masotti@live.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Programming Language :: Python :: 3", "Topic :: Utilities" ], "description": "Markdown Table Of Contents\n==========================\n\n|pypiver| |license| |pyver| |downloads| |gitter| |dependentrepos|\n\n.. |pypiver| image:: https://img.shields.io/pypi/v/md-toc.svg\n :alt: PyPI md-toc version\n\n.. |license| image:: https://img.shields.io/pypi/l/md-toc.svg?color=blue\n :alt: PyPI - License\n :target: https://raw.githubusercontent.com/frnmst/md-toc/master/LICENSE.txt\n\n.. |pyver| image:: https://img.shields.io/pypi/pyversions/md-toc.svg\n :alt: PyPI - Python Version\n\n.. |downloads| image:: https://pepy.tech/badge/md-toc\n :alt: Downloads\n :target: https://pepy.tech/project/md-toc\n\n.. |gitter| image:: https://badges.gitter.im/md-toc/community.svg\n :alt: Gitter\n :target: https://gitter.im/md-toc/community\n\n.. |dependentrepos| image:: https://img.shields.io/librariesio/dependent-repos/pypi/md-toc.svg\n :alt: Dependent repos (via libraries.io)\n\nAutomatically generate a compliant table of contents for a markdown file to \nimprove document readability.\n\nVideo\n-----\n\n.. image:: https://asciinema.org/a/251312.png\n :target: https://asciinema.org/a/251312\n :align: center\n\nDescription\n-----------\n\nThe table of contents (a.k.a: TOC) generated by this program is designed to \nwork with several markdown parsers such as the ones used by GitHub and GitLab.\n\nWhen used with the in-place option this script will write the TOC at the first\noccurrency of a marker. The default marker is ````, which, being \nan HTML comment, will result invisible after the markdown file has \nbeen translated.\n\nBy default titles up to three indentation levels (in HTML: ``h1``, ``h2``, \n``h3``) will be included in the TOC but the user can decide to keep all\npossible levels.\n\nmd_toc makes it is possible to generate ordered and unordered TOCs.\nIn both cases each element of the TOC is by default a\nlink to a paragraph in the web page. It is also possible to generate \na non-linked version of the TOC. \n\nIf the user wants it, there is the possibility to ignore space indentations\nwithin the TOC and to skip an initial number of lines from the markdown file.\n\nRules for generating the TOC are determined by the selected \nmarkdown parser. md-toc aimes infact to be as conformant as possible in \nrespect to each one of them. This was possible by studying the available \ndocumentations and by reverse engineering the source codes.\n\nDocumentation\n-------------\n\nhttp://frnmst.github.io/md-toc\n\nPlease read carefully the `Markdown specification`_ section of the documentation \nto learn how this program parsers markdown files and builds a correct output.\n\n.. _Markdown specification: http://frnmst.github.io/md-toc/markdown_specification.html\n\nAPI examples\n------------\n\nmd-toc has a `public API`_. This means for example that you can you easily \nbuild a TOC within another Python program. The easiest way to build one \nfor a markdown file is:\n\n\n::\n\n\n >>> import md_toc\n >>> f = open('foo.md')\n >>> print(f.read(), end='')\n # this\n ## is\n ## a\n ### foo\n #### booo\n ### foo\n ## file\n\n ## bye\n\n # bye\n >>> print(md_toc.build_toc('foo.md'), end='')\n - [this](#this)\n - [is](#is)\n - [a](#a)\n - [foo](#foo)\n - [foo](#foo-1)\n - [file](#file)\n - [bye](#bye)\n - [bye](#bye-1)\n\n\n.. _public API: https://frnmst.github.io/md-toc/api.html\n\nCLI Helps\n---------\n\n\n::\n\n\n $ md_toc --help\n $ md_toc github --help\n $ md_toc redcarpet --help\n\n\nLicense\n-------\n\nCopyright (C) 2017-2019 frnmst (Franco Masotti) \n\nmd-toc is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nmd-toc is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with md-toc. If not, see .\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/frnmst/md-toc", "keywords": "markdown toc", "license": "GPL", "maintainer": "", "maintainer_email": "", "name": "md-toc", "package_url": "https://pypi.org/project/md-toc/", "platform": "", "project_url": "https://pypi.org/project/md-toc/", "project_urls": { "Homepage": "https://github.com/frnmst/md-toc" }, "release_url": "https://pypi.org/project/md-toc/6.0.0/", "requires_dist": [ "fpyutils (==1.1.0)" ], "requires_python": ">=3.5, <4", "summary": "A utility that is able to generate a table of contents for a markdown file.", "version": "6.0.0" }, "last_serial": 5391583, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "0c078cae00b5ad4ec48658f149123361", "sha256": "c7e566c9ce6dd15855b03dc4c66005e8bd725c34659c3d0cece843d98c4b677b" }, "downloads": -1, "filename": "md_toc-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0c078cae00b5ad4ec48658f149123361", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 15111, "upload_time": "2018-01-05T17:37:47", "url": "https://files.pythonhosted.org/packages/e4/bb/aba7c83a60011574a1e76c76b9fd0fb7f49dae21887ab9c34d53ad8aaaa5/md_toc-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fe063a952cd5613904b82ba63849391c", "sha256": "a78d34ad84b7fa3717e0dd5d955816f1320f9674df460383a3a6e9ef5672dd3a" }, "downloads": -1, "filename": "md_toc-0.0.1.tar.gz", "has_sig": false, "md5_digest": "fe063a952cd5613904b82ba63849391c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 21789, "upload_time": "2018-01-05T17:37:49", "url": "https://files.pythonhosted.org/packages/58/35/d6b33ae5d933e45c683db8a52fd1ec84a9db06c019a87ce77a23fb58a193/md_toc-0.0.1.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "d41f13be0b3cf1142d53a8e55adce9b5", "sha256": "6e9d14fbb305702674c1d6dec481d2d572c8c009a7eddce446beeb33df0efd63" }, "downloads": -1, "filename": "md_toc-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d41f13be0b3cf1142d53a8e55adce9b5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 16982, "upload_time": "2018-01-27T16:22:21", "url": "https://files.pythonhosted.org/packages/f2/34/420c955028c8b93be40ecb45f797fcc79eb096168658ecfb0d04fec7f667/md_toc-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "23c7e454d9289da6c619b131ae44402c", "sha256": "1011688fd56546d35a55b99ce9ee165095222acee0f49c77a52f399cdd90f2c0" }, "downloads": -1, "filename": "md_toc-1.0.0.tar.gz", "has_sig": false, "md5_digest": "23c7e454d9289da6c619b131ae44402c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 23426, "upload_time": "2018-01-27T16:22:24", "url": "https://files.pythonhosted.org/packages/42/f9/f32947ecfb6fba2f996c763f290c1d9cc6a2494edb3538f6b8f49b965e65/md_toc-1.0.0.tar.gz" } ], "2.0.0": [ { "comment_text": "", "digests": { "md5": "a216bddcf97984241122c38cc472337e", "sha256": "69da57f2beb3709eb4b222e41c2bca6da71a5a60a8afa3d511cc2440429d68f5" }, "downloads": -1, "filename": "md_toc-2.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "a216bddcf97984241122c38cc472337e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 21795, "upload_time": "2018-03-18T19:15:31", "url": "https://files.pythonhosted.org/packages/ee/78/3057378a9985fa8b2ec75cd643d343b960a2270c552a0ef1ad4fa752f3d0/md_toc-2.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "85a42f163b4f90d7bd5932151267be1d", "sha256": "f992e8ffa9ba39e8f8d269fea526b8e2a03e77ab785aab56618a163709eaabac" }, "downloads": -1, "filename": "md_toc-2.0.0.tar.gz", "has_sig": false, "md5_digest": "85a42f163b4f90d7bd5932151267be1d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 27240, "upload_time": "2018-03-18T19:15:33", "url": "https://files.pythonhosted.org/packages/ed/06/260df10115f12e94f394f25a3a046e5e10638c0325da00611195361eed2d/md_toc-2.0.0.tar.gz" } ], "2.0.1": [ { "comment_text": "", "digests": { "md5": "6603f8230e9ec74ed6682c4fa30c22c6", "sha256": "d179058317a75c33c11e64d5404488d149df51f9b87af554fec95932af763ff0" }, "downloads": -1, "filename": "md_toc-2.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "6603f8230e9ec74ed6682c4fa30c22c6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 17886, "upload_time": "2018-03-25T16:05:11", "url": "https://files.pythonhosted.org/packages/d8/fa/e2cb0c8847f1e73d5d645c3d10b16a8ab149bc43d01ce347510b69126262/md_toc-2.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c278292dd79a99ec4e23146f02313430", "sha256": "9147b103dba57295d77e06293af6628f00f774f6d3ddfc2bb10c259b60b53c2f" }, "downloads": -1, "filename": "md_toc-2.0.1.tar.gz", "has_sig": false, "md5_digest": "c278292dd79a99ec4e23146f02313430", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 24582, "upload_time": "2018-03-25T16:05:13", "url": "https://files.pythonhosted.org/packages/7b/2d/9ea34c834a9460db89e4727f368bbf279dcd2e4a5946f6cfabfc4841b7e0/md_toc-2.0.1.tar.gz" } ], "3.0.0": [ { "comment_text": "", "digests": { "md5": "706fd215dc21aa1d3c2d18375c75f4a6", "sha256": "32ede9d83975fa8b86768dd38535142ea152ed22c117ad9baf6eda4dffeef577" }, "downloads": -1, "filename": "md_toc-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "706fd215dc21aa1d3c2d18375c75f4a6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 28765, "upload_time": "2019-03-18T16:53:55", "url": "https://files.pythonhosted.org/packages/ae/4c/cfcbf571fd47902f0fdaa698076c33783a386f3366309ec5167a71952e2e/md_toc-3.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f5347075db53e48b218972117d9ea204", "sha256": "80b6767099852a8c7031f6276753dcccc70bf2b59a35695004fb535459315c2e" }, "downloads": -1, "filename": "md_toc-3.0.0.tar.gz", "has_sig": false, "md5_digest": "f5347075db53e48b218972117d9ea204", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 26647, "upload_time": "2019-03-18T16:53:57", "url": "https://files.pythonhosted.org/packages/c6/e7/d9d3e5c57b7b707a2323b4a243f6e6a5de5a8b1205be7752492aab632377/md_toc-3.0.0.tar.gz" } ], "3.1.0": [ { "comment_text": "", "digests": { "md5": "4b02573553aa0bcc7694cb1075cff789", "sha256": "8e3078c0e0e54a28d269a646c2683e259fec04ec074a4218689f72e352a11d75" }, "downloads": -1, "filename": "md_toc-3.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4b02573553aa0bcc7694cb1075cff789", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5, <4", "size": 29672, "upload_time": "2019-03-29T13:07:53", "url": "https://files.pythonhosted.org/packages/77/98/0d935313d86bff56f9d3d8f846c86e5554fcc87ca85512e94b8b0dd03ab0/md_toc-3.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b5f37aadd5e7f927a5452594025e17ec", "sha256": "91421e91d2f2184a20e55085e79fdb20e0d4bfe0d60470c6cabd997b959d0d55" }, "downloads": -1, "filename": "md_toc-3.1.0.tar.gz", "has_sig": false, "md5_digest": "b5f37aadd5e7f927a5452594025e17ec", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5, <4", "size": 27015, "upload_time": "2019-03-29T13:07:55", "url": "https://files.pythonhosted.org/packages/a1/c4/fd8f3bdff707b1bb6e94c68ff511f2c5daef8f182ea2aaaab08fd0756070/md_toc-3.1.0.tar.gz" } ], "4.0.0": [ { "comment_text": "", "digests": { "md5": "3ee310b8ad38587b72e5279f8cca52d3", "sha256": "20be9c68f3e98e950e75d0b3c506d1368287b10b37f12bfd498d432496dfc92b" }, "downloads": -1, "filename": "md_toc-4.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "3ee310b8ad38587b72e5279f8cca52d3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5, <4", "size": 29965, "upload_time": "2019-04-04T16:36:12", "url": "https://files.pythonhosted.org/packages/a8/37/267a79351d73901d1fff21c2bcc2c81d546d729f76dedb003f5de05a9846/md_toc-4.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "53268090c25f107edf71c3324cb0f413", "sha256": "c489f115a8eeebe25c374ca223850c574d6b00eb713804dff876d95cc50d5a5f" }, "downloads": -1, "filename": "md_toc-4.0.0.tar.gz", "has_sig": false, "md5_digest": "53268090c25f107edf71c3324cb0f413", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5, <4", "size": 27663, "upload_time": "2019-04-04T16:36:14", "url": "https://files.pythonhosted.org/packages/d9/37/58d1d48e2d86eee581c6fd4258658861082c4da76903de9f5f25a55f7710/md_toc-4.0.0.tar.gz" } ], "5.0.0": [ { "comment_text": "", "digests": { "md5": "f1e78e28c53ee324e2d4f00068e09f26", "sha256": "04a48cb8db0a6d9042d1474de7a8d02ac42429ec1bc30dc1b59fd877a6f5da52" }, "downloads": -1, "filename": "md_toc-5.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "f1e78e28c53ee324e2d4f00068e09f26", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5, <4", "size": 30571, "upload_time": "2019-04-14T17:19:57", "url": "https://files.pythonhosted.org/packages/78/26/bcac47692ac8aec9ad82c3a33a02da6f5f10cc93705c20ef9ff17bf063d2/md_toc-5.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f5593d7bc61afbc0f370c9684cec1423", "sha256": "1736bd70274690e9a2f8e289d6da4645f7ec28c6fd12b389115881f7ff0f15a1" }, "downloads": -1, "filename": "md_toc-5.0.0.tar.gz", "has_sig": false, "md5_digest": "f5593d7bc61afbc0f370c9684cec1423", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5, <4", "size": 28231, "upload_time": "2019-04-14T17:19:59", "url": "https://files.pythonhosted.org/packages/0d/38/05e240ec70e22404605db39750dd86f630256ad8e99c9b982c3d6265c1cf/md_toc-5.0.0.tar.gz" } ], "5.0.1": [ { "comment_text": "", "digests": { "md5": "daefdd0dcca985437b70dffffcf2ad51", "sha256": "cd4c4e9374226019f981c0343056da59048090ed2c72a8124dccb57a4e640cdb" }, "downloads": -1, "filename": "md_toc-5.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "daefdd0dcca985437b70dffffcf2ad51", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5, <4", "size": 30565, "upload_time": "2019-05-03T10:33:16", "url": "https://files.pythonhosted.org/packages/80/ee/94fd0f457cd5527b86706c12a83880caa4d0c299d65c9f57ef0d3fb7f0c3/md_toc-5.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1ac8ceea9222f894bb863db44fe31937", "sha256": "28cd4bae3a79eb8e5f7ccbc1bdb06eb783bb9df95182e40826cfc34ab5050d42" }, "downloads": -1, "filename": "md_toc-5.0.1.tar.gz", "has_sig": false, "md5_digest": "1ac8ceea9222f894bb863db44fe31937", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5, <4", "size": 28228, "upload_time": "2019-05-03T10:33:19", "url": "https://files.pythonhosted.org/packages/0d/cf/471aab7b981936151d44c2672a59f4b390cabea582089d0bef45680aa686/md_toc-5.0.1.tar.gz" } ], "6.0.0": [ { "comment_text": "", "digests": { "md5": "5a70bdc526bf0291ace996d091d74566", "sha256": "51a4d4891c7c5758ed1731c5bddc7c8eeb68f7192d4a17de2283f60c85017b96" }, "downloads": -1, "filename": "md_toc-6.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5a70bdc526bf0291ace996d091d74566", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5, <4", "size": 30910, "upload_time": "2019-06-12T14:56:31", "url": "https://files.pythonhosted.org/packages/ab/28/4aa5cf613e4fe476a17ea91882a63348444d6bcc4927c3d05cd6f7c5fac9/md_toc-6.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "78d5f5866667c97775a762d889cd9b03", "sha256": "7e0e84f648545968b18ab904c85f4cb744d6995ee315ae6820630a1f1cc06f8d" }, "downloads": -1, "filename": "md_toc-6.0.0.tar.gz", "has_sig": false, "md5_digest": "78d5f5866667c97775a762d889cd9b03", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5, <4", "size": 28518, "upload_time": "2019-06-12T14:56:34", "url": "https://files.pythonhosted.org/packages/10/2e/ae157f14e05fdc6db4e098c038cfc41c5f3970531445a2a368ff1ee2a2db/md_toc-6.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5a70bdc526bf0291ace996d091d74566", "sha256": "51a4d4891c7c5758ed1731c5bddc7c8eeb68f7192d4a17de2283f60c85017b96" }, "downloads": -1, "filename": "md_toc-6.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5a70bdc526bf0291ace996d091d74566", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5, <4", "size": 30910, "upload_time": "2019-06-12T14:56:31", "url": "https://files.pythonhosted.org/packages/ab/28/4aa5cf613e4fe476a17ea91882a63348444d6bcc4927c3d05cd6f7c5fac9/md_toc-6.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "78d5f5866667c97775a762d889cd9b03", "sha256": "7e0e84f648545968b18ab904c85f4cb744d6995ee315ae6820630a1f1cc06f8d" }, "downloads": -1, "filename": "md_toc-6.0.0.tar.gz", "has_sig": false, "md5_digest": "78d5f5866667c97775a762d889cd9b03", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5, <4", "size": 28518, "upload_time": "2019-06-12T14:56:34", "url": "https://files.pythonhosted.org/packages/10/2e/ae157f14e05fdc6db4e098c038cfc41c5f3970531445a2a368ff1ee2a2db/md_toc-6.0.0.tar.gz" } ] }