Skip to content

Commit

Permalink
fix template format
Browse files Browse the repository at this point in the history
  • Loading branch information
mariana-caetano committed Jan 15, 2024
1 parent 0cda117 commit 1333f9f
Showing 1 changed file with 41 additions and 43 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -145,71 +145,69 @@ Represents the highest criticality level. If the user ignores the information gi
A basic documentation template structure with the previously described sections for you to start.

```bash
# {Insert the app's name}
# {Insert the app's name}

The `{insert app's name}` is responsible for `{app's purpose}` so you can `{job to be done}`.
The `{insert app's name}` is responsible for `{app's purpose}` so you can `{job to be done}`.

`![insert-an-image-preview](/)`
`![insert-an-image-preview](/)`

## Before you start
## Before you start

You need to have `{insert what the user needs to have: an account in another platform, CLI, knowledge in another app, etc}`.
You need to have `{insert what the user needs to have: an account in another platform, CLI, knowledge in another app, etc}`.

If you do not have `{insert what the user needs to have and how it can be done}`.
If you do not have `{insert what the user needs to have and how it can be done}`.

## Installation
## Installation

1. [Install](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-installing-an-app) the `{insert app's name}` app in the desired VTEX account by running `vtex install {appVendor}.{appName}` in your terminal.
2. Open your store’s Store Theme app directory in your code editor.
3. Open your app's `manifest.json file` and add the `{insert app's name}` app under the `peerDependencies` field.
1. [Install](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-installing-an-app) the `{insert app's name}` app in the desired VTEX account by running `vtex install {appVendor}.{appName}` in your terminal.
2. Open your store’s Store Theme app directory in your code editor.
3. Open your app's `manifest.json file` and add the `{insert app's name}` app under the `peerDependencies` field.
```json
```json
"peerDependencies": {
"vtex.{appName}": "{appVersion}"
}
"peerDependencies": {
"vtex.{appName}": "{appVersion}"
}
```
4. Declare the `{insert app's name}` app in the desired template. For example:
```
```json

4. Declare the `{insert app's name}` app in the desired template. For example:
"store.home": {
"blocks": [
+ "{app-name}",
]
},
```

```json
*![insert-an-image-preview](/)*

"store.home": {
"blocks": [
+ "{app-name}",
]
},
## Configuration

```
Once you have installed the app, you can `{describe the app's configuration in the VTEX Admin, for example}`.
*![insert-an-image-preview](/)*
1. `first step`.
2. `Second step`.
3. `Third step`.
## Configuration
## Customization
Once you have installed the app, you can `{describe the app's configuration in the VTEX Admin, for example}`.
To apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization).
1. `first step`.
2. `Second step`.
3. `Third step`.
| CSS Handles |
| ------------------ |
| csshandlesName |
| csshandlesName |
| csshandlesName |
## Customization
## Contributors
To apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization).
Thanks go to these wonderful people:
| CSS Handles |
| ------------------ |
| csshandlesName |
| csshandlesName |
| csshandlesName |
- `{insert the GitHub username}`
## Contributors
Thanks go to these wonderful people:
- `{insert the GitHub username}`
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome.
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome.
```
Expand Down

0 comments on commit 1333f9f

Please sign in to comment.