Skip to content

Commit 8798263

Browse files
committed
build(lint-md): added a lint script for markdown
1 parent 7561675 commit 8798263

File tree

4 files changed

+22
-10
lines changed

4 files changed

+22
-10
lines changed

.editorconfig

+3
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,6 @@ indent_size = 2
2222

2323
[package.json]
2424
indent_size = 2
25+
26+
[*.md]
27+
indent_size = 2

.markdownlintrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"commands-show-output": false
3+
}

README.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# React components for https://admin.travi.org
1+
# React components for <https://admin.travi.org>
22

33
[![Build Status](https://img.shields.io/travis/travi/admin.travi.org-components.svg?style=flat)](https://travis-ci.org/travi/admin.travi.org-components)
44
[![Coverage Status](http://img.shields.io/coveralls/travi/admin.travi.org-components.svg?style=flat)](https://coveralls.io/r/travi/admin.travi.org-components?branch=master)
@@ -9,41 +9,44 @@
99
[![license](https://img.shields.io/github/license/travi/admin.travi.org-components.svg)](LICENSE)
1010
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
1111

12-
1312
## Install
14-
```
13+
14+
```bash
1515
$ npm install @travi/admin.travi.org-components --save-dev
1616
```
1717

18-
## View the components
18+
## View a demo of the components
1919

2020
The latest version of the components are hosted [on GitHub Pages](https://travi.github.io/admin.travi.org-components)
2121

2222
## Key Technology
23+
2324
- [x] [npm](https://npmjs.com)
2425
- [x] [React](https://facebook.github.io/react/)
2526
- [x] [React Storybook](https://github.com/kadirahq/react-storybook)
26-
* Addons
27-
- [x] [specifications](https://github.com/mthuret/storybook-addon-specifications)
28-
- [x] [info](https://github.com/kadirahq/react-storybook-addon-info)
27+
- Addons
28+
- [x] [specifications](https://github.com/mthuret/storybook-addon-specifications)
29+
- [x] [info](https://github.com/kadirahq/react-storybook-addon-info)
2930
- [x] [CSS Modules](https://github.com/css-modules/css-modules)
3031
- [x] [Sass](http://sass-lang.com/)
3132

3233
## Local Development
3334

3435
### Install dependencies
3536

36-
```
37+
```bash
3738
$ nvm install
3839
$ npm install
3940
```
4041

4142
### View the components
42-
```
43+
44+
```bash
4345
$ npm start
4446
```
4547

4648
### Run verification
47-
```
49+
50+
```bash
4851
$ npm test
4952
```

package.json

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "0.11.1",
44
"description": "React components for https://admin.travi.org",
55
"scripts": {
6+
"lint:md": "globstar --node -- markdownlint **/*.md",
67
"test": "grunt && run-s test:*",
78
"test:integration": "mocha stories/ -r .storybook/mocha-config.js --compilers js:babel-register",
89
"start": "start-storybook -p 9002",
@@ -52,6 +53,7 @@
5253
"enzyme": "2.7.0",
5354
"file-loader": "0.9.0",
5455
"gh-pages": "0.12.0",
56+
"globstar": "1.0.0",
5557
"greenkeeper-postpublish": "1.0.1",
5658
"grunt": "1.0.1",
5759
"grunt-babel": "6.0.0",
@@ -69,6 +71,7 @@
6971
"istanbul": "1.0.0-alpha.2",
7072
"jsdom": "9.9.1",
7173
"load-grunt-config": "0.19.2",
74+
"markdownlint-cli": "0.2.0",
7275
"mocha": "3.2.0",
7376
"node-sass": "4.3.0",
7477
"npm-run-all": "4.0.1",

0 commit comments

Comments
 (0)