Skip to content

Usage instructions should mention <-- toc --> marker at the beginning #99

@dbooth-boston

Description

@dbooth-boston

It would help if the usage instructions said up front said something like:

  1. Add the following line to your markdown file where you want your TOC inserted:
    <-- toc -->
  2. Run markdown-toc:
    ...

This information does appear much later in the README.md, but it would help to have it right up front also.

Let me know if I should submit a Pull Request for this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions