danger-toc
A plugin for danger.systems that makes sure your project’s README.md has a TOC.
Table of Contents
- Installation
- Usage
- toc.files
- toc.header
- toc.check!
- Contributing
- Copyright
Installation
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.
Usage
Methods and settings from this plugin are available in your Dangerfile under the toc namespace.
toc.files
List of files to ensure TOC in, default is README.md.
config.files = [ 'README.md', 'DEV.md' ]toc.header
The Table of Contents header, without #, default is Table of Contents.
config.header = 'Custom Table of Contents'toc.check!
Run all checks.
Contributing
See CONTRIBUTING.
Copyright
Copyright (c) Daniel Doubrovkine, 2017-2019
MIT License, see LICENSE for details.