Skip to content

Commit

Permalink
Update docs from master to main
Browse files Browse the repository at this point in the history
  • Loading branch information
madmath committed Jan 29, 2025
1 parent 0b19fde commit 64a2bc7
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 20 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# How to contribute
We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or
just correct a typo, please feel free to do so, as long as you follow
our [Code of Conduct](https://github.com/Shopify/js-buy-sdk/blob/master/CODE_OF_CONDUCT.md).
our [Code of Conduct](https://github.com/Shopify/js-buy-sdk/blob/main/CODE_OF_CONDUCT.md).

If you're thinking of adding a big new feature, consider opening an
issue first to discuss it to ensure it aligns to the direction of the
Expand Down
8 changes: 4 additions & 4 deletions DEPLOYING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Deploying and publishing BuyButton.js

Pull from master and install all dependencies
Pull from main and install all dependencies
```
git pull origin master
git pull origin main
yarn install
```
Then run
Expand All @@ -18,7 +18,7 @@ Which will do 3 things:
- create a tag

```
git push origin master --tags
git push origin main --tags
```

Then deploy to S3 and NPM via [Shipit](https://shipit.shopify.io/shopify/buy-button-js/production)
Then deploy via [Shipit](https://shipit.shopify.io/shopify/buy-button-js/production)
14 changes: 7 additions & 7 deletions docs/configuration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h2>product</h2>
<td>templates</td>
<td>object</td>
<td>mustache templates used to display contents</td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/master/src/templates/product.js">product.js</a></td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/main/src/templates/product.js">product.js</a></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -237,7 +237,7 @@ <h2>modalProduct</h2>
<td>templates</td>
<td>object</td>
<td>mustache templates used to display contents</td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/master/src/templates/product.js">product.js</a></td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/main/src/templates/product.js">product.js</a></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -294,7 +294,7 @@ <h2>modal</h2>
<td>templates</td>
<td>object</td>
<td>mustache templates used to display contents</td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/master/src/templates/modal.js">modal.js</a></td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/main/src/templates/modal.js">modal.js</a></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -407,7 +407,7 @@ <h2>option</h2>
<td>templates</td>
<td>object</td>
<td>mustache templates used to display contents</td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/master/src/templates/option.js">option.js</a></td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/main/src/templates/option.js">option.js</a></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -495,7 +495,7 @@ <h2>cart</h2>
<td>templates</td>
<td>object</td>
<td>mustache templates used to display contents</td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/master/src/templates/cart.js">cart.js</a></td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/main/src/templates/cart.js">cart.js</a></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -556,7 +556,7 @@ <h2>lineItem</h2>
<td>templates</td>
<td>object</td>
<td>mustache templates used to display contents</td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/master/src/templates/line-item.js">line-item.js</a></td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/main/src/templates/line-item.js">line-item.js</a></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -637,7 +637,7 @@ <h2>toggle</h2>
<td>templates</td>
<td>object</td>
<td>mustache templates used to display contents</td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/master/src/templates/toggle.js">toggle.js</a></td>
<td><a href="https://github.com/Shopify/buy-button-js/blob/main/src/templates/toggle.js">toggle.js</a></td>
<td></td>
</tr>
</tbody>
Expand Down
10 changes: 5 additions & 5 deletions docs/customization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ var order = [

**Type**: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)

**Default value**: dependent on component. [View default values for all components](https://github.com/Shopify/buy-button-js/blob/master/src/defaults/components.js)
**Default value**: dependent on component. [View default values for all components](https://github.com/Shopify/buy-button-js/blob/main/src/defaults/components.js)

### `contents`

Expand All @@ -83,7 +83,7 @@ var contents = {
```

**Type**: object
**Default value**: dependent on component. [View component defaults](https://github.com/Shopify/buy-button-js/blob/master/src/defaults/components.js)
**Default value**: dependent on component. [View component defaults](https://github.com/Shopify/buy-button-js/blob/main/src/defaults/components.js)

### `text`

Expand All @@ -99,7 +99,7 @@ var text = {

**Type**: object

**Default value**: dependent on component. [View component defaults](https://github.com/Shopify/buy-button-js/blob/master/src/defaults/components.js)
**Default value**: dependent on component. [View component defaults](https://github.com/Shopify/buy-button-js/blob/main/src/defaults/components.js)

### `styles`

Expand All @@ -118,7 +118,7 @@ var styles = {

**Type**: object

**Default value**: dependent on component. [View component defaults](https://github.com/Shopify/buy-button-js/blob/master/src/defaults/components.js)
**Default value**: dependent on component. [View component defaults](https://github.com/Shopify/buy-button-js/blob/main/src/defaults/components.js)

### `events`

Expand Down Expand Up @@ -419,7 +419,7 @@ Determines class names added to elements within components. It is unlikely you w

**Type**: Object

**Default values**: dependent on component. [View defaults](https://github.com/Shopify/buy-button-js/blob/master/src/defaults/components.js).
**Default values**: dependent on component. [View defaults](https://github.com/Shopify/buy-button-js/blob/main/src/defaults/components.js).

### `templates`
Determines the HTML for each element in a component. Templates are specified as strings using the [Mustache](https://github.com/janl/mustache.js/) templating engine, which implements the [Mustache](https://mustache.github.io/) syntax.
Expand Down
2 changes: 1 addition & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
- `npm run doc-serve`

## Deployment
Changes to the `docs` directory will automatically be deployed to http://shopify.github.io/js-buy-sdk/ when added to `master` (remote).
Changes to the `docs` directory will automatically be deployed to http://shopify.github.io/js-buy-sdk/ when added to `main` (remote).
3 changes: 1 addition & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# BuyButton.js

[BuyButton.js on NPM](https://www.npmjs.com/package/@shopify/buy-button-js)
[![Travis](https://travis-ci.com/Shopify/buy-button-js.svg?branch=master)](https://travis-ci.com/Shopify/buy-button-js)

BuyButton.js is a highly customizable UI library for adding ecommerce functionality to any website. It allows you to create interactive UI components such as product listings and shopping carts with minimal configuration, while allowing you to easily customize the appearance and behaviour of the components.
It uses the [JS Buy SDK](http://shopify.github.io/js-buy-sdk/) to connect to your Shopify store, giving you access to your products and collections.
Expand Down Expand Up @@ -53,4 +52,4 @@ yarn run docs
```
Doc server will run at http://localhost:4000/buy-button-js/
Docs source files are located in /docs.
Docs are automatically deployed to gh-pages from master.
Docs are automatically deployed to gh-pages from main.

0 comments on commit 64a2bc7

Please sign in to comment.