Support special tags to insert a TOC

The script will generate a TOC for a Markdown file, based on the headers in the file.

It generates and prints the TOC to the console, and optionally also inserts it into the original file.

For the latter, it will first create a backup copy of the file and then replace any section named "# Contents" with the new table of contents.

For the latter, it will first create a backup copy of the file and then replace any section named "# Contents" with the new table of contents **in the original input document**.

###  Support for Table-of-Content Tags

Some renderers support special tags in the Markdown document to automatically insert a TOC. This script supports the following tags:

- `<!--TOC-->`

- `[TOC]`

- `[CONTENT]`

If the `--toctags` and `--add-content` options are specified, the script will replace these tags with the generated TOC in the original input document. To keep the original document intact, it may be a good idea to first create a backup copy of the document and work on that copy.

## Prerequisites

## Command Line Options

```

usage: generateTOC.py [-h] [--add-content] [--contents] [--indent <indent>] [--level LEVELS] document

usage: generateTOC.py [-h] [--add-content] [--contents] [--indent <indent>]

                      [--level LEVELS] [--toc-tags]

                      document

positional arguments:

  document              document to parse

options:

  -h, --help            show this help message and exit

  --add-content, -a     add TOC to "# Content" section in the document (default: False)

  --contents, -c        add link to "Contents" section in the generated TOC (default: False)

  --contents, -c        add link to "Contents" section in the generated TOC (default:

                        False)

  --indent <indent>, -i <indent>

                        indent spaces for each level (default: 4)

  --level LEVELS, -l LEVELS

                        limit the TOC levels; 0 means no limit (default: 0)

  --toc-tags, -t        replace special TOC tokens in the document (default: False)

```

 No newline at end of file

from rich import print

tocTags:[str] = ['[TOC]', '[CONTENT]', '<!--TOC-->']

"""	TOC tags to replace in the document with the TOC. """

def backupFile(filename:str) -> None:

	"""	Backup a file.

						continue

					inToc = False

				# Write the new TOC

				if line.strip() == '# Contents':

				# Write the new TOC in the right place

				if (args.tocTags and line.strip() in tocTags) or line.strip() == '# Contents':

					inToc = True

					f.write(to)

					continue

	parser.add_argument('--contents', '-c', action='store_true', dest='contents', default = False, help = 'add link to "Contents" section in the generated TOC')

	parser.add_argument('--indent', '-i', action='store', dest='indent', type = nonNegativeInt, default = 4, metavar = '<indent>', help = 'indent spaces for each level')

	parser.add_argument('--level', '-l', action='store', dest='levels', type = nonNegativeInt, default = 0, help = 'limit the TOC levels; 0 means no limit')

	parser.add_argument('--toc-tags', '-t', action='store_true', dest='tocTags', default = False, help = 'replace special TOC tokens in the document')

	parser.add_argument('document', help = 'document to parse')

	args = parser.parse_args()