docs(toc): generated an initial readme table of contents

.remarkrc.js

@@ -1 +1,13 @@
-exports.plugins = ['remark-preset-lint-travi'];
+// https://github.com/remarkjs/remark/tree/master/packages/remark-stringify#options
+exports.settings = {
+  listItemIndent: 1,
+  emphasis: '_',
+  strong: '_',
+  bullet: '*',
+  incrementListMarker: false
+};
+
+exports.plugins = [
+  'remark-preset-lint-travi',
+  [require('remark-toc'), {tight: true}]
+];

README.md

@@ -3,12 +3,22 @@
 VCS scaffolder for projects to be hosted on GitHub
 
 <!-- status badges -->
+
 [![Build Status][ci-badge]][ci-link]
 [![Codecov][coverage-badge]][coverage-link]
 
+## Table of Contents
+
+* [Usage](#usage)
+  * [Installation](#installation)
+* [Contributing](#contributing)
+  * [Dependencies](#dependencies)
+  * [Verification](#verification)
+
 ## Usage
 
 <!-- consumer badges -->
+
 [![npm][npm-badge]][npm-link]
 [![MIT license][license-badge]][license-link]
 
@@ -21,6 +31,7 @@ $ npm install @travi/github-scaffolder --prod
 ## Contributing
 
 <!-- contribution badges -->
+
 [![Conventional Commits][commit-convention-badge]][commit-convention-link]
 [![Commitizen friendly][commitizen-badge]][commitizen-link]
 [![semantic-release][semantic-release-badge]][semantic-release-link]
@@ -41,18 +52,33 @@ $ npm test
 ```
 
 [npm-link]: https://www.npmjs.com/package/@travi/github-scaffolder
+
 [npm-badge]: https://img.shields.io/npm/v/@travi/github-scaffolder.svg
+
 [license-link]: LICENSE
+
 [license-badge]: https://img.shields.io/github/license/travi/github-scaffolder.svg
+
 [ci-link]: https://travis-ci.com/travi/github-scaffolder
+
 [ci-badge]: https://img.shields.io/travis/com/travi/github-scaffolder/master.svg
+
 [coverage-link]: https://codecov.io/github/travi/github-scaffolder
+
 [coverage-badge]: https://img.shields.io/codecov/c/github/travi/github-scaffolder.svg
+
 [commit-convention-link]: https://conventionalcommits.org
+
 [commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+
 [commitizen-link]: http://commitizen.github.io/cz-cli/
+
 [commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
+
 [semantic-release-link]: https://github.com/semantic-release/semantic-release
+
 [semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+
 [PRs-link]: http://makeapullrequest.com
+
 [PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg

package.json

@@ -21,6 +21,7 @@
     "coverage:report": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
     "build": "run-s clean build:*",
     "build:js": "rollup -c",
+    "generate:md": "remark . --output",
     "watch": "run-s 'build:js -- --watch'",
     "prepack": "run-s build"
   },
@@ -50,6 +51,7 @@
     "remark": "^10.0.1",
     "remark-cli": "^6.0.1",
     "remark-preset-lint-travi": "^1.1.0",
+    "remark-toc": "^5.1.1",
     "rimraf": "^2.6.2",
     "rollup": "^1.1.2",
     "rollup-plugin-auto-external": "^2.0.0",