Maihunter789

Latest version

Released:

Autogenerated Table of Contents for Github Markdown or Bear Notes

Project description

Github Markdown Guide

This is an adaption of the github markdown previewer and uses github readme styling.

Generated by the script ;)

Table of Contents

• Installation
• Usage

• A open-source (GPL-3) R package to facilitate writing books and long-form articles/reports with R Markdown. Features include: Generate printer-ready books and ebooks from R Markdown documents; A markup language easier to learn than LaTeX, and to write elements such as section headers, lists, quotes, figures, tables, and citations.
• Markdown is a standard developed by John Gruber. The main goal with Markdown is to make the file possible to read even in pure text. If you want to look in a text-only editor, you should have an easy time reading it. This is very helpful for users of vim and similar.

Overview

I love using Bear Notes for note taking of all sorts. Recently, Bear released a feature that allowed headers to be linked with x-callback-urls. 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)

Manually

Usage

Github Markdown Style

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'

‎

• Add a Table of Contents to a Bear Note with the UUID 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'

‎

• Add a Table of Contents to all Bear Notes that contain the tag #bear OR tag #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.

Github Markdown Code

With Markdown Files

• Add of a Table of Contents to README.md (Using Github Anchors)

‎

• Add of a Table of Contents to README.md and Folder/README2.md (Using Github Anchors)

Release historyRelease notifications | RSS feed

1.2.6

1.2.4

Github Readme Markdown Latex

1.2.3

1.2.2

1.2.1

1.2.0

1.1.3

1.1.2

Markdown Files Github

1.1.1

1.1

1.0.1

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Hashes for markdown_toc-1.2.6-py3-none-any.whl

Hashes for markdown-toc-1.2.6.tar.gz