A plugin for danger.systems that makes sure your project’s README.md has a TOC.

• Installation
• Usage
  • toc.files
  • toc.header
  • toc.check!
• Contributing
• Copyright

Add danger-toc to your Gemfile.

gem 'danger-toc', '~> 0.1'

Add toc.check to your Dangerfile. Make a pull request and see this plugin in action.

Methods and settings from this plugin are available in your Dangerfile under the toc namespace.

List of files to ensure TOC in, default is README.md.

config.files = [ 'README.md', 'DEV.md' ]

The Table of Contents header, without #, default is Table of Contents.

config.header = 'Custom Table of Contents'

Run all checks.

See CONTRIBUTING.

Copyright (c) Daniel Doubrovkine, 2017-2019

MIT License, see LICENSE for details.