VTEX Content Style Guide

This portal was created to guide VTEX employees on writing and content standardization guidelines, ensuring quality and uniformity in the company's communication.

🛠 Technologies

This project utilizes the following technologies:

• React and Next.js for building the interface
• Algolia for searching and indexing Markdown files
• content-portal-content as the source repository for content

📦 Installation and Execution

To set up the development environment, follow these steps:

1. Clone this repository:

   git clone https://github.com/vtex/vtex-content-style-guide.git
   cd vtex-content-style-guide

2. Install dependencies:

   yarn install

3. Start the development server:

   yarn dev

4. To generate a production build:

   yarn build

🚀 Contributing

This repository is public and accepts contributions from company members. If you wish to contribute, follow these steps:

1. Fork the repository
2. Create a branch for your changes: git checkout -b my-change
3. Make the necessary modifications
4. Commit and push your changes: git push origin my-change
5. Open a Pull Request and wait for review 🚀

---

If you have any questions or suggestions, feel free to open an issue! 😊