Adding a Table of Contents in MacDown App

As a user of MacDown, you're likely familiar with its powerful features that make writing and publishing documents a breeze. One feature that can enhance the overall reading experience is the ability to add a table of contents (TOC). In this article, we'll explore how to add a TOC in MacDown app.

Why Add a Table of Contents?

A table of contents provides readers with a quick overview of your document's structure and helps them navigate through it easily. This is particularly useful for long documents or articles that contain multiple sections and subheadings.

Adding a Table of Contents in MacDown App

To add a TOC in MacDown app, you'll need to use the `toc` parameter in your YAML front-matter. Here's an example of how to do it:

```

title: My Document

toc: true

```

Once you've added the `toc` parameter, MacDown will automatically generate a table of contents at the beginning of your document.

Customizing Your Table of Contents

If you want to customize your TOC further, you can use additional parameters in your YAML front-matter. For example, you can specify the level of headings that should be included in the TOC using the `toc_levels` parameter:

```

title: My Document

toc: true

toc_levels: 3

```

In this example, MacDown will generate a TOC that includes headings up to level 3 (i.e., heading 1, heading 2, and heading 3).

Adding a table of contents in MacDown app is a simple process that can enhance the readability and usability of your documents. By following the steps outlined above, you can easily generate a TOC that helps readers navigate through your content with ease.

Macdown app add table of contents