Commitc71b2d6

authored

Enforce asterisk-style unordered lists (#41)

* Enforce asterisk-style unordered lists* Update affected project documentation* Fix test options

1 parent37bdbda commitc71b2d6Copy full SHA for c71b2d6

File tree

+17

-13

lines changed

+17

-13

lines changed

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@ Thank you for your interest in contributing.`
`6`	`6`
`7`	`7`	`Depending on your needs, you may have one of two development paths:`
`8`	`8`
`9`		`-- via integrating with an existing usage (ideal for modifying the interface of our rules)`
`10`		`-- via unit testing (ideal for adding a new rule)`
	`9`	`+* via integrating with an existing usage (ideal for modifying the interface of our rules)`
	`10`	`+* via unit testing (ideal for adding a new rule)`
`11`	`11`
`12`	`12`	`For that reason we've included two paths to develop. Feel free to use either, or both.`
`13`	`13`
`@@ -32,8 +32,8 @@ It may be useful to work on this in tandem with a codebase that uses the rules.`
`32`	`32`	If you go to the`node_modules` directoryin your codebase and try to navigate into the package, you'll notice that whatever changes you make in your local development directory will be reflected in the codebase.
`33`	`33`
`34`	`34`	3. Reset symlinks at any time by reversing the steps via `npm unlink`.
`35`		-- in your codebase: `npm unlink @github/markdownlint-github`
`36`		-- in this directory: `npm unlink`
	`35`	+* in your codebase: `npm unlink @github/markdownlint-github`
	`36`	+* in this directory: `npm unlink`
`37`	`37`
`38`	`38`	`### Unit and Interface Testing`
`39`	`39`

Lines changed: 7 additions & 7 deletions

Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,8 @@ See opinions codified in [index.js](./index.js).`
`12`	`12`
`13`	`13`	`The following are custom rules defined in this plugin.`
`14`	`14`
`15`		`--[GH001_no-default-alt-text_](./docs/rules/GH001-no-default-alt-text.md)`
`16`		`--[GH002_no-generic-link-text_](./docs/rules/GH002-no-generic-link-text.md)`
	`15`	`+[GH001*_no-default-alt-text_](./docs/rules/GH001-no-default-alt-text.md)`
	`16`	`+[GH002*_no-generic-link-text_](./docs/rules/GH002-no-generic-link-text.md)`
`17`	`17`
`18`	`18`	See[`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--aliases) for documentation on rules pulled in from`markdownlint`.
`19`	`19`
@@ -29,11 +29,11 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
`29`	`29`
`30`	`30`	`2. Install packages.`
`31`	`31`
`32`		--```bash
`33`		`-npm install -D markdownlint-cli2# if updating existing package, check for updates`
`34`		`-npm install -D @github/markdownlint-github [--@github:registry=https://registry.npmjs.org]`
`35`		`-npm install -D markdownlint-cli2-formatter-pretty`
`36`		-```
	`32`	+```bash
	`33`	`+ npm install -D markdownlint-cli2# if updating existing package, check for updates`
	`34`	`+ npm install -D @github/markdownlint-github [--@github:registry=https://registry.npmjs.org]`
	`35`	`+ npm install -D markdownlint-cli2-formatter-pretty`
	`36`	+```
`37`	`37`
`38`	`38`	3. Add/modify your linting scriptin`package.json`.
`39`	`39`

Lines changed: 3 additions & 1 deletion

Lines changed: 3 additions & 1 deletion

Comments

(0)