{ "info": { "author": "Alexander Lee", "author_email": "hello@alexanderlee.co", "bugtrack_url": null, "classifiers": [], "description": "# Autogenerated Table of Contents for Github Markdown or Bear Notes\n\n> Generated by the script ;)\n## Table of Contents\n* [Overview](#Overview)\n* [Installation](#Installation)\n\t* [PyPi (Preferred)](#PyPi-(Preferred))\n\t* [Manually](#Manually)\n* [Usage](#Usage)\n\t* [Flags](#Flags)\n\t* [With Bear](#With-Bear)\n\t* [With Markdown Files](#With-Markdown-Files)\n\n## Overview\nI love using [Bear Notes](https://bear.app/) for note taking of all sorts. Recently, Bear released a feature that allowed headers to be linked with [x-callback-urls](http://x-callback-url.com/). And thus, I created a script to autogenerate a Table of Contents for your notes based on the headers.\n\n## Installation\n*NOTE:* This program is only compatible with Python 3.x\n\n### PyPi (Preferred)\n```sh\n$ pip3 install markdown-toc --upgrade\n```\n\n### Manually\n```sh\n$ git clone https://github.com/alexander-lee/markdown-github-bear-toc.git\n\n$ cd markdown-github-bear-toc\n$ python3 setup.py install\n```\n\n## Usage\n### Flags\n* `-h` or `--header-priority` is the Limiting Header Priority/Strength (whether you limit your Table of Contents to h3s or h4s)\n* `-t` or `--type` is the type of anchor you want to use (Github or Bear x-callback-url)\n* `--no-write` is a flag on whether you want to disable the feature that automatically injects the ToC into your Markdown file or Bear Note\n* `-toc` or `--table-of-contents-style` is the Markdown style for your Table of Contents header\n\n### With Bear\n* Add a Table of Contents to a Bear Note with the title \"Bear Note Title\"\n```sh\n$ markdown-toc -h -t bear [--no-write] \"Bear Note Title\"\n```\n\u200e\n\n* Add a Table of Contents to a Bear Note with the UUID `20703126-FA33-400A-B98E-F55F57E3EF48-47683-000143B2335758CA`\n```sh\n$ markdown-toc -h -t bear [--no-write] \"20703126-FA33-400A-B98E-F55F57E3EF48-47683-000143B2335758CA\"\n```\n\u200e\n\n* Add a Table of Contents to two Bear Notes with titles \"Bear Note Title 1\" and \"Bear Note Title 2\"\n```sh\n$ markdown-toc -h -t bear [--no-write] \"Bear Note Title 1\" \"Bear Note Title 2\"\n```\n\u200e\n\n* Add a Table of Contents to all Bear Notes that contain the tag `#bear` OR tag `#beet`\n```sh\n$ markdown-toc -h -t bear [--no-write] \"#bear\" \"#beet\"\n```\n\u200e\n\n* This allows you to take input a list of Bear Note titles, tags, or UUIDs and will inject the ToC into your note whether or not you submit the `--no-write` flag.\n* If you have `#tags` at the top of your note (cause I use them to categorize my notes), it will inject the ToC right after any tags.\n\n| **Original Note** | **Note with ToC** |\n| :---: | :---: |\n|![Original Note](https://github.com/alexander-lee/markdown-github-bear-toc/blob/master/images/Original%20Note.png?raw=true)|![Note with ToC](https://github.com/alexander-lee/markdown-github-bear-toc/blob/master/images/Note%20with%20ToC.png?raw=true)|\n\n### With Markdown Files\n* Add of a Table of Contents to README.md (Using Github Anchors)\n```sh\n$ markdown-toc -h -t github [--no-write] README.md\n```\n\u200e\n\n* Add of a Table of Contents to README.md and Folder/README2.md (Using Github Anchors)\n```sh\n$ markdown-toc -h -t github [--no-write] README.md Folder/README2.md\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/alexander-lee/markdown-github-bear-toc", "keywords": "markdown md github bear table of contents toc", "license": "LICENSE", "maintainer": "", "maintainer_email": "", "name": "markdown-toc", "package_url": "https://pypi.org/project/markdown-toc/", "platform": "", "project_url": "https://pypi.org/project/markdown-toc/", "project_urls": { "Homepage": "https://github.com/alexander-lee/markdown-github-bear-toc" }, "release_url": "https://pypi.org/project/markdown-toc/1.2.6/", "requires_dist": [ "python-dateutil" ], "requires_python": "", "summary": "Autogenerated Table of Contents for Github Markdown or Bear Notes", "version": "1.2.6" }, "last_serial": 5628082, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "9c056e4203944974ebc5f3e57e49424e", "sha256": "4587099734adb2b5c43da7bfaad9b6c6c7fc98a72317f06b094b8f9f7051b410" }, "downloads": -1, "filename": "markdown_toc-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "9c056e4203944974ebc5f3e57e49424e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5912, "upload_time": "2018-11-30T06:33:33", "url": "https://files.pythonhosted.org/packages/18/99/359685a5179053b505e691cbf75b40ce464246ab5e501c7c46628e32f822/markdown_toc-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c61a0eeeb33abcb9bc58e85b5e298066", "sha256": "fca3ae7e57beee9bfd92509ee2856b281e21e165a16461bd10ab9efe5a8dbd6f" }, "downloads": -1, "filename": "markdown-toc-1.0.tar.gz", "has_sig": false, "md5_digest": "c61a0eeeb33abcb9bc58e85b5e298066", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5129, "upload_time": "2018-11-30T06:33:35", "url": "https://files.pythonhosted.org/packages/91/d4/fc5a0a54ca8fbca6259d59a7a374683f08a59945236b4302b787b1162050/markdown-toc-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "af63d35607f6c44da76508d01e7b4b22", "sha256": "5d7de1c80ecf72efbfd56c77a660fb619be4c173a28302790a902bf3cdd71808" }, "downloads": -1, "filename": "markdown-toc-1.0.1.tar.gz", "has_sig": false, "md5_digest": "af63d35607f6c44da76508d01e7b4b22", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5440, "upload_time": "2018-11-30T06:39:17", "url": "https://files.pythonhosted.org/packages/af/bb/f35b2fa655f10b8e916d751c0f58708d1972d3f15779735cf58267649c9e/markdown-toc-1.0.1.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "ec49ff7ef045df42cd1d995876e19c2e", "sha256": "b0817534713bebaf673b6173b9075844f85b7774b067cfb568642344e3b5d355" }, "downloads": -1, "filename": "markdown-toc-1.1.tar.gz", "has_sig": false, "md5_digest": "ec49ff7ef045df42cd1d995876e19c2e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5434, "upload_time": "2018-11-30T06:41:05", "url": "https://files.pythonhosted.org/packages/c6/6a/40a810a980cb6da80c3c1727656a387ac18ef89e97c099d387a326f90490/markdown-toc-1.1.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "04ce6063e12563b377e6aec135356b17", "sha256": "a78ac4908614098122a0b526004678248cb7b3c83fdd1169e6c5fb12b9947fbf" }, "downloads": -1, "filename": "markdown-toc-1.1.1.tar.gz", "has_sig": false, "md5_digest": "04ce6063e12563b377e6aec135356b17", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5415, "upload_time": "2018-11-30T06:43:01", "url": "https://files.pythonhosted.org/packages/f4/d5/0d009558d21bba8f4d4c1c2e2fe74c70a4ce5d3c973f51c76a2034352ded/markdown-toc-1.1.1.tar.gz" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "b5d6cb2f7adf293a035a174f9196989e", "sha256": "c010fdc1efe40ae112c2363e4895ec5d86cb934d71b3bdc8308de0657fd1201e" }, "downloads": -1, "filename": "markdown-toc-1.1.2.tar.gz", "has_sig": false, "md5_digest": "b5d6cb2f7adf293a035a174f9196989e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5606, "upload_time": "2018-11-30T06:57:40", "url": "https://files.pythonhosted.org/packages/19/0b/8eaf8dd73a8571abc7b453bdd8e5d7eb0e5527d34d1f9a8fd23716118e0e/markdown-toc-1.1.2.tar.gz" } ], "1.1.3": [ { "comment_text": "", "digests": { "md5": "0c9a3be29f2223e73ad8b236f20f2228", "sha256": "b3e523055300d182ab194132e2bbd00b6f01819f29c55616c1fba68fd795547a" }, "downloads": -1, "filename": "markdown-toc-1.1.3.tar.gz", "has_sig": false, "md5_digest": "0c9a3be29f2223e73ad8b236f20f2228", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5648, "upload_time": "2018-11-30T07:19:57", "url": "https://files.pythonhosted.org/packages/2a/1a/2e42c0d81e9bd3c8ff61aa4c95df6b873d532f9398a826bb3bee47c87e2e/markdown-toc-1.1.3.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "ada92337810c2ae9b392a1361965932d", "sha256": "3c607da59176eb8ba534ccf225bcf9db0870912b9e34e9c538a1b29596a39608" }, "downloads": -1, "filename": "markdown-toc-1.2.0.tar.gz", "has_sig": false, "md5_digest": "ada92337810c2ae9b392a1361965932d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6116, "upload_time": "2018-11-30T18:00:09", "url": "https://files.pythonhosted.org/packages/f8/e3/2ab584b7662e219ecb2a2bc7efd5e5e095a7eeedc28b981b7f79d8c99ed4/markdown-toc-1.2.0.tar.gz" } ], "1.2.1": [ { "comment_text": "", "digests": { "md5": "f291646735df4386ce59e4d26b0e963b", "sha256": "bf1ae9bc60010a93f7cd85c7c11a2877b3a9f683eaa5e01f5cf124bb053a26e8" }, "downloads": -1, "filename": "markdown-toc-1.2.1.tar.gz", "has_sig": false, "md5_digest": "f291646735df4386ce59e4d26b0e963b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6127, "upload_time": "2018-11-30T18:01:23", "url": "https://files.pythonhosted.org/packages/bb/b3/829bfb4a56e2c1eb14293f31129e741912dbaf42829ef81968aafd3d9d67/markdown-toc-1.2.1.tar.gz" } ], "1.2.2": [ { "comment_text": "", "digests": { "md5": "0108267774c5bc69ea4477762ed40538", "sha256": "26b6956efc107b5f43e52d42ceb12f92f5f2c9d42ef2bdfff080136d8811f44a" }, "downloads": -1, "filename": "markdown-toc-1.2.2.tar.gz", "has_sig": false, "md5_digest": "0108267774c5bc69ea4477762ed40538", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6309, "upload_time": "2018-11-30T19:07:48", "url": "https://files.pythonhosted.org/packages/e9/cb/4094b3dde8f25d1abb8802263b9f38339e8839172887bb4c54b69489c761/markdown-toc-1.2.2.tar.gz" } ], "1.2.3": [ { "comment_text": "", "digests": { "md5": "31d104b5e41b1bf357a4e197929f6b4d", "sha256": "5ac1114c3d453942c3cb8eff1928bfaa7db17f06f898e5ad543eb569a61ef201" }, "downloads": -1, "filename": "markdown-toc-1.2.3.tar.gz", "has_sig": false, "md5_digest": "31d104b5e41b1bf357a4e197929f6b4d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6632, "upload_time": "2018-12-01T17:49:40", "url": "https://files.pythonhosted.org/packages/6f/44/3d1de9736200d7bf1f64ddfd0c6ae434beb904f10affddfc96d529c767ee/markdown-toc-1.2.3.tar.gz" } ], "1.2.4": [ { "comment_text": "", "digests": { "md5": "4b78d9a2b6eba0f10ed888b0252c2020", "sha256": "ba8c38f4d2bac34549d583a3d3dfd8f9948445c7c013330815b6f7abe897ad0b" }, "downloads": -1, "filename": "markdown_toc-1.2.4-py3.6.egg", "has_sig": false, "md5_digest": "4b78d9a2b6eba0f10ed888b0252c2020", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 12614, "upload_time": "2019-08-03T12:25:21", "url": "https://files.pythonhosted.org/packages/9e/4c/dad08202225879b423c78e3f5ff472a94d42a520b423bc5db425648e3fce/markdown_toc-1.2.4-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "cf7979869a33e3d47a5c0be1e417977e", "sha256": "65f30f11dfe238de7f8f8e4e1e3f87e5e9ddd42fc0cd5a95880bdb98f2592c1e" }, "downloads": -1, "filename": "markdown_toc-1.2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "cf7979869a33e3d47a5c0be1e417977e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8127, "upload_time": "2019-08-03T12:25:16", "url": "https://files.pythonhosted.org/packages/1b/10/a2ed5b2ac46bebbc104dc879c477ef6f50d34529d654ed5e58b2dee35483/markdown_toc-1.2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0929e4d288eb2671ad017ff15e5db17c", "sha256": "1612ec6907b66be79be136f707f749a0a5d0e957dffedc186d8099ed76eaf534" }, "downloads": -1, "filename": "markdown-toc-1.2.4.tar.gz", "has_sig": false, "md5_digest": "0929e4d288eb2671ad017ff15e5db17c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6682, "upload_time": "2018-12-05T18:22:22", "url": "https://files.pythonhosted.org/packages/f4/89/714c2a2222042152661f69fa4b6748ebf9a3368dfc1c4fe6111c49824d39/markdown-toc-1.2.4.tar.gz" } ], "1.2.6": [ { "comment_text": "", "digests": { "md5": "0a26caf18733825b613c1496e3eb9025", "sha256": "63706ab4ccde4c82840f79197cefbcf47dc2a25582cf86187a83a9206cb38345" }, "downloads": -1, "filename": "markdown_toc-1.2.6-py3-none-any.whl", "has_sig": false, "md5_digest": "0a26caf18733825b613c1496e3eb9025", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8125, "upload_time": "2019-08-03T12:25:18", "url": "https://files.pythonhosted.org/packages/86/9b/a2ef42a5a1bcba508afec04da982839681ee62fa9dded969692f3cbb7ae7/markdown_toc-1.2.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "75e97adc1fb83b8a394d91536ff05647", "sha256": "8e89536688000c05b329df220e8036211c572af376cc83cee8763335711c19bd" }, "downloads": -1, "filename": "markdown-toc-1.2.6.tar.gz", "has_sig": false, "md5_digest": "75e97adc1fb83b8a394d91536ff05647", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6718, "upload_time": "2019-08-03T12:25:19", "url": "https://files.pythonhosted.org/packages/22/2e/a41b4efe2ffab22e7f1aeba325fb843117dce9386530ba7efa89c5c14b96/markdown-toc-1.2.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0a26caf18733825b613c1496e3eb9025", "sha256": "63706ab4ccde4c82840f79197cefbcf47dc2a25582cf86187a83a9206cb38345" }, "downloads": -1, "filename": "markdown_toc-1.2.6-py3-none-any.whl", "has_sig": false, "md5_digest": "0a26caf18733825b613c1496e3eb9025", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8125, "upload_time": "2019-08-03T12:25:18", "url": "https://files.pythonhosted.org/packages/86/9b/a2ef42a5a1bcba508afec04da982839681ee62fa9dded969692f3cbb7ae7/markdown_toc-1.2.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "75e97adc1fb83b8a394d91536ff05647", "sha256": "8e89536688000c05b329df220e8036211c572af376cc83cee8763335711c19bd" }, "downloads": -1, "filename": "markdown-toc-1.2.6.tar.gz", "has_sig": false, "md5_digest": "75e97adc1fb83b8a394d91536ff05647", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6718, "upload_time": "2019-08-03T12:25:19", "url": "https://files.pythonhosted.org/packages/22/2e/a41b4efe2ffab22e7f1aeba325fb843117dce9386530ba7efa89c5c14b96/markdown-toc-1.2.6.tar.gz" } ] }