diff --git a/.remarkrc.js b/.remarkrc.js index 3a9502dc..83adbb38 100644 --- a/.remarkrc.js +++ b/.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}] +]; diff --git a/README.md b/README.md index ef88e8a3..32f049f7 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,22 @@ VCS scaffolder for projects to be hosted on GitHub + [![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 + [![npm][npm-badge]][npm-link] [![MIT license][license-badge]][license-link] @@ -21,6 +31,7 @@ $ npm install @travi/github-scaffolder --prod ## Contributing + [![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 diff --git a/package-lock.json b/package-lock.json index 88281dc3..7c005f94 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5611,6 +5611,18 @@ "integrity": "sha512-2qLt/DEOo5F6nc2VFScQiHPzQ0XXcabquRJxKMhKte8nt42o08HUxNDPk7tt0YPxnWjAT11I1SYi0X0iPnfI5A==", "dev": true }, + "mdast-util-toc": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-toc/-/mdast-util-toc-3.1.0.tgz", + "integrity": "sha512-Za0hqL1PqWrvxGtA/3NH9D5nhGAUS9grMM4obEAz5+zsk1RIw/vWUchkaoDLNdrwk05A0CSC5eEXng36/1qE5w==", + "dev": true, + "requires": { + "github-slugger": "^1.2.1", + "mdast-util-to-string": "^1.0.5", + "unist-util-is": "^2.1.2", + "unist-util-visit": "^1.1.0" + } + }, "memorystream": { "version": "0.3.1", "resolved": "https://registry.npmjs.org/memorystream/-/memorystream-0.3.1.tgz", @@ -8249,6 +8261,17 @@ "remark-validate-links": "^7.1.0" } }, + "remark-slug": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/remark-slug/-/remark-slug-5.1.1.tgz", + "integrity": "sha512-r591rdoDPJkSSAVvEaTVUkqbMp7c7AyZfif14V0Dp66GQkOHzaPAS6wyhawSbqpS0ZdTnfJS+TltFoxzi6bdIA==", + "dev": true, + "requires": { + "github-slugger": "^1.0.0", + "mdast-util-to-string": "^1.0.0", + "unist-util-visit": "^1.0.0" + } + }, "remark-stringify": { "version": "6.0.4", "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-6.0.4.tgz", @@ -8271,6 +8294,16 @@ "xtend": "^4.0.1" } }, + "remark-toc": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/remark-toc/-/remark-toc-5.1.1.tgz", + "integrity": "sha512-vCPW4YOsm2CfyuScdktM9KDnJXVHJsd/ZeRtst+dnBU3B3KKvt8bc+bs5syJjyptAHfqo7H+5Uhz+2blWBfwow==", + "dev": true, + "requires": { + "mdast-util-toc": "^3.0.0", + "remark-slug": "^5.0.0" + } + }, "remark-validate-links": { "version": "7.1.2", "resolved": "https://registry.npmjs.org/remark-validate-links/-/remark-validate-links-7.1.2.tgz", diff --git a/package.json b/package.json index fa7c5106..c96a37a5 100644 --- a/package.json +++ b/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",