Skip to content

Commit

Permalink
[SDPA-572] Updated Documentation generation script.
Browse files Browse the repository at this point in the history
* Updated ripple dev site URL
* Added markdown linter to `npm run lint`
* Updated readme template to be lint compliant
  • Loading branch information
alan-cole committed Jul 24, 2018
1 parent aa8d5ab commit a49ca17
Show file tree
Hide file tree
Showing 33 changed files with 343 additions and 572 deletions.
3 changes: 3 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"default": true
}
168 changes: 144 additions & 24 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"private": true,
"scripts": {
"publish": "lerna publish",
"lint": "eslint --ext .js,.vue src && sass-lint -qv --max-warnings 0",
"lint": "eslint --ext .js,.vue src && sass-lint -qv --max-warnings 0 && markdownlint ./packages/**/*.md",
"test": "NODE_ENV=test jest",
"storybook": "start-storybook -p 3000 -c .storybook -s ./static",
"build-storybook": "build-storybook -c .storybook -s ./static",
Expand All @@ -21,7 +21,7 @@
"bay:pull": "docker image ls --format \"{{.Repository}}:{{.Tag}}\" | grep amazeeio | grep -v none | xargs -n1 docker pull | cat",
"bay:test": "docker-compose run test npm test",
"install-curl": "if [ \"$LAGOON_GIT_BRANCH\" != \"production\" ] ; then apk --update add curl; fi",
"docs": "node ./docs/docs.js"
"docs": "node ./scripts/generate-readme/generate-readme.js"
},
"dependencies": {
"@dpc-sdp/ripple-anchor-links": "file:packages/Molecules/AnchorLinks",
Expand Down Expand Up @@ -81,6 +81,7 @@
"jest": "^23.3.0",
"lerna": "^2.11.0",
"markdown-loader-jest": "^0.1.1",
"markdownlint-cli": "^0.11.0",
"node-sass": "^4.7.2",
"sass-lint": "^1.12.1",
"sass-loader": "^6.0.7",
Expand All @@ -94,7 +95,8 @@
"vue-jest": "^2.6.0",
"vue-loader": "^14.2.3",
"vue-style-loader": "^3.0.1",
"vue-template-compiler": "^2.5.2"
"vue-template-compiler": "^2.5.2",
"wordwrap": "^1.0.0"
},
"engines": {
"node": ">= 8.9.0",
Expand Down
21 changes: 4 additions & 17 deletions packages/Atoms/Button/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
@dpc-sdp/ripple-button
============

> A button themed element. Will be a `<button>` by default, or a an `<a>` if a `href` is provided.
# @dpc-sdp/ripple-button

> A button themed element. Will be a `<button>` by default, or a an `<a>` if a
`href` is provided.

--------------------------------------------------------------------------------


## Install


```shell
npm install @dpc-sdp/ripple-button --save
```


--------------------------------------------------------------------------------


## Dependency graph

```shell
Expand All @@ -26,28 +21,20 @@ npm install @dpc-sdp/ripple-button --save
└── @dpc-sdp/ripple-link
```


--------------------------------------------------------------------------------


## Usage and Tests

See [Storybook/Button](http://ripple-vic-gov-au-master.lagoon.vicsdp.amazee.io/?selectedKind=Atoms/Button&selectedStory=Button).

See [Storybook/Button](https://ripple-ripple-develop.lagoon.vicsdp.amazee.io/?selectedKind=Atoms/Button&selectedStory=Button).

--------------------------------------------------------------------------------


## Release History

See [CHANGELOG.md](./CHANGELOG.md).


--------------------------------------------------------------------------------


## License

Licensed under the GPL-2.0+ License.


Loading

0 comments on commit a49ca17

Please sign in to comment.