Skip to content
This repository was archived by the owner on Feb 22, 2021. It is now read-only.

Commit a248794

Browse files
committed
publish styleguide to Netlify page
1 parent c0bcb49 commit a248794

File tree

6 files changed

+9
-10
lines changed

6 files changed

+9
-10
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,4 @@ yarn-error.log
33
dist
44
coverage
55
.cache
6-
demo
7-
styleguide
6+
docs

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Blazing fast address autocomplete React/preact component. :zap:
44

55
# Demo
6-
![Demo GIF](https://raw.githubusercontent.com/kontrollanten/algolia-places-react/master/algolia-places-react.gif)
76
[Checkout the demo at https://address-autocomplete-react.netlify.com/](https://address-autocomplete-react.netlify.com/)
7+
![Demo GIF](https://raw.githubusercontent.com/kontrollanten/algolia-places-react/master/algolia-places-react.gif)
88

99
## Installation
1010
```bash
@@ -56,8 +56,7 @@ export default () => {
5656
);
5757
}
5858
```
59-
60-
Read more at [Algolia Places site](https://community.algolia.com/places/documentation.html)
59+
[Full API documentation](https://address-autocomplete-react.netlify.com/api)
6160

6261
## Todo
6362
Implement support for using [Places methods](https://community.algolia.com/places/documentation.html#methods)

e2e/App.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ export default class App extends React.Component {
8686
}
8787
/>
8888

89-
<Link href="https://github.com/kontrollanten/algolia-places-react" target="_blank">
90-
Further documentation at GitHub
89+
<Link href="/api">
90+
Read API documentation here
9191
</Link>
9292

9393
</Box>

netlify.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[build]
2-
command = "yarn demo:build"
3-
publish = "demo"
2+
command = "yarn demo:build && yarn styleguide:build"
3+
publish = "docs"
44
branch = "master"

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"scripts": {
1010
"build": "webpack",
1111
"demo": "parcel e2e/index.html",
12-
"demo:build": "parcel build e2e/index.html -d demo --public-url /",
12+
"demo:build": "parcel build e2e/index.html -d docs --public-url /",
1313
"styleguide": "styleguidist server",
1414
"styleguide:build": "styleguidist build",
1515
"test": "jest",

styleguide.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ module.exports = {
33
webpackConfig: require('./webpack.config.js'),
44
showSidebar: false,
55
showUsage: true,
6+
styleguideDir: 'docs/api',
67
}

0 commit comments

Comments
 (0)