# Autogenerated Table of Contents for Github Markdown or Bear Notes
> Generated by the script ;)
## Table of Contents
* [Overview](#Overview)
* [Installation](#Installation)
* [PyPi (Preferred)](#PyPi-(Preferred))
* [Manually](#Manually)
* [Usage](#Usage)
* [Flags](#Flags)
* [With Bear](#With-Bear)
* [With Markdown Files](#With-Markdown-Files)
## Overview
I 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.
## Installation
*NOTE:* This program is only compatible with Python 3.x
### PyPi (Preferred)
```sh
$ pip3 install markdown-toc --upgrade
```
### Manually
```sh
$ git clone https://github.com/alexander-lee/markdown-github-bear-toc.git
$ cd markdown-github-bear-toc
$ python3 setup.py install
```
## Usage
### Flags
* `-h` or `--header-priority` is the Limiting Header Priority/Strength (whether you limit your Table of Contents to h3s or h4s)
* `-t` or `--type` is the type of anchor you want to use (Github or Bear x-callback-url)
* `--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
* `-toc` or `--table-of-contents-style` is the Markdown style for your Table of Contents header
### With Bear
* Add a Table of Contents to a Bear Note with the title "Bear Note Title"
```sh
$ markdown-toc -h <default: 3> -t bear [--no-write] "Bear Note Title"
```
* Add a Table of Contents to a Bear Note with the UUID `20703126-FA33-400A-B98E-F55F57E3EF48-47683-000143B2335758CA`
```sh
$ markdown-toc -h <default: 3> -t bear [--no-write] "20703126-FA33-400A-B98E-F55F57E3EF48-47683-000143B2335758CA"
```
* Add a Table of Contents to two Bear Notes with titles "Bear Note Title 1" and "Bear Note Title 2"
```sh
$ markdown-toc -h <default: 3> -t bear [--no-write] "Bear Note Title 1" "Bear Note Title 2"
```
* Add a Table of Contents to all Bear Notes that contain the tag `#bear` OR tag `#beet`
```sh
$ markdown-toc -h <default: 3> -t bear [--no-write] "#bear" "#beet"
```
* 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.
* 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.
| **Original Note** | **Note with ToC** |
| :---: | :---: |
|||
### With Markdown Files
* Add of a Table of Contents to README.md (Using Github Anchors)
```sh
$ markdown-toc -h <default: 3> -t github [--no-write] README.md
```
* Add of a Table of Contents to README.md and Folder/README2.md (Using Github Anchors)
```sh
$ markdown-toc -h <default: 3> -t github [--no-write] README.md Folder/README2.md
```
Raw data
{
"_id": null,
"home_page": "https://github.com/alexander-lee/markdown-github-bear-toc",
"name": "markdown-toc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "markdown md github bear table of contents toc",
"author": "Alexander Lee",
"author_email": "hello@alexanderlee.co",
"download_url": "https://files.pythonhosted.org/packages/22/2e/a41b4efe2ffab22e7f1aeba325fb843117dce9386530ba7efa89c5c14b96/markdown-toc-1.2.6.tar.gz",
"platform": "",
"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 <default: 3> -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 <default: 3> -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 <default: 3> -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 <default: 3> -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|||\n\n### With Markdown Files\n* Add of a Table of Contents to README.md (Using Github Anchors)\n```sh\n$ markdown-toc -h <default: 3> -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 <default: 3> -t github [--no-write] README.md Folder/README2.md\n```\n\n\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "Autogenerated Table of Contents for Github Markdown or Bear Notes",
"version": "1.2.6",
"project_urls": {
"Homepage": "https://github.com/alexander-lee/markdown-github-bear-toc"
},
"split_keywords": [
"markdown",
"md",
"github",
"bear",
"table",
"of",
"contents",
"toc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "869ba2ef42a5a1bcba508afec04da982839681ee62fa9dded969692f3cbb7ae7",
"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",
"upload_time_iso_8601": "2019-08-03T12:25:18.119466Z",
"url": "https://files.pythonhosted.org/packages/86/9b/a2ef42a5a1bcba508afec04da982839681ee62fa9dded969692f3cbb7ae7/markdown_toc-1.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "222ea41b4efe2ffab22e7f1aeba325fb843117dce9386530ba7efa89c5c14b96",
"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",
"upload_time_iso_8601": "2019-08-03T12:25:19.913262Z",
"url": "https://files.pythonhosted.org/packages/22/2e/a41b4efe2ffab22e7f1aeba325fb843117dce9386530ba7efa89c5c14b96/markdown-toc-1.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-08-03 12:25:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alexander-lee",
"github_project": "markdown-github-bear-toc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "markdown-toc"
}
JSON
