Vaunt Documentation

Welcome to the Vaunt documentation. This readme will guide you through the setup and usage of the Vaunt platform.

---

Table of Contents

1. Introduction
2. Prerequisites
3. Getting Started
4. Development Setup
5. Commands
   • Install Dependencies
   • Local Development
   • Build
   • Deployment

---

Introduction

Vaunt is a platform designed to help developers showcase their work and connect with others. It also provides tools for organizations and repository owners to enhance developer relations (DevRel), fostering meaningful relationships between developers and their products.

Note: This documentation is built using Docusaurus 3.

Prerequisites

Before getting started, ensure you have the following installed:

• Node.js v16.13.0 or higher
• A package manager:
  • Yarn (recommended)
  • npm

---

Getting Started

To begin, clone the repository and navigate to the project directory:

git clone https://github.com/VauntDev/docs.git
cd docs

---

Development Setup

After cloning the repository, install the required dependencies using either Yarn or npm:

Install Dependencies

Using Yarn:

yarn

Using npm:

npm install

---

Commands

Local Development

Start a local development server:

Using Yarn:

yarn start

Using npm:

npx docusaurus start

This command starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.

---

Build

Generate static content for deployment:

Using Yarn:

yarn build

Using npm:

npm run build

The static content will be generated in the build directory, which can be served using any static content hosting service.

---

Deployment

Deploy the site to GitHub Pages:

Using SSH:

Using Yarn:

USE_SSH=true yarn deploy

Using npm:

USE_SSH=true npm run deploy

Not Using SSH:

Using Yarn:

GIT_USER=<Your GitHub username> yarn deploy

Using npm:

GIT_USER=<Your GitHub username> npm run deploy

If you are hosting on GitHub Pages, this command builds the website and pushes it to the gh-pages branch.

---

Notes

• For more information about Docusaurus, visit the official documentation.
• Ensure you have the correct permissions to deploy to the repository if using the deployment commands.

---