Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ jobs:
with:
path: docs/.vitepress/dist



# Deployment job
deploy:
environment:
Expand Down
9 changes: 9 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"$schema": "https://json.schemastore.org/prettierrc",
"semi": false,
"singleQuote": true,
"tabWidth": 2,
"printWidth": 80,
"vueIndentScriptAndStyle": true,
"trailingComma": "none"
}
88 changes: 53 additions & 35 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
- [Running the Development Server](#run-on-dev)
- [Building for Production](#building-for-production)


Thank you for your interest in contributing to the VirakCloud Documentation! This guide will walk you through the steps to add new pages, use images, configure paths, and manage comments effectively.

## Getting Started :wave: { #getting-started }
Expand All @@ -28,16 +27,19 @@ cd <repository-directory>
### install packages:

#### Using npm:

```bash
npm install
```

### Using Yarn:

```bash
yarn install
```

### Using pnpm:

```bash
pnpm i
```
Expand All @@ -47,14 +49,14 @@ pnpm i
- **`docs/`**: Contains all the documentation files, organized by language and section.
- **`docs/.vitepress`**: Configuration files for VitePress, including themes, plugins, and customization options.


## Adding a New Guide Page :page_facing_up: { #adding-page }

To add a new guide page:

1. **Navigate to the Appropriate Language Directory**: For example, `docs/fa/guides`.
2. **Create a Markdown File**: Add a new `.md` file with a descriptive name. For example, `new-feature.md`.
3. **Set Up Frontmatter(Optional)**:

```markdown
---
title: عنوان صفحه
Expand All @@ -65,16 +67,19 @@ To add a new guide page:
- **description**: A brief description that will appear in search engines and social previews.

4. **Add Content**: Write your content in markdown. Here’s a sample layout:

```markdown
# Page Title
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

## Second Title
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

## Third Title
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
```

5. **Link the Page**: If you want to add navigation to the new page, edit the sidebar configuration in `docs/.vitepress/config.ts`.
Expand All @@ -89,7 +94,6 @@ To add images:

> **:warning: Note:** Please ensure that images are in WEBP format and optimized to the maximum extent before uploading. For best results, images should be sized between 700 and 1200 pixels. Optimized images will help improve loading times and enhance the overall performance of the website.


2. **Use in Markdown**:
```markdown
![Alt text](../../images/filename.webp)
Expand All @@ -104,56 +108,70 @@ If you need different images for dark mode, use the `<DarkModeImage />` componen
```

## Running the Development Server :rocket: {#run-on-dev}

To start the development server, run one of the following commands based on your package manager:

### Using npm:
``` bash

```bash
npm run docs:dev
```

### Using Yarn:

```bash
yarn docs:dev
```

### Using pnpm:

```bash
pnpm docs:dev
```



## Building for Production :hammer_and_wrench: {#building-for-production}

To build the project for production, use one of the following commands:

1. ### Build the Project:
#### Using npm:
``` bash
npm run docs:build
```

#### Using Yarn:
```bash
yarn docs:build
```
#### Using pnpm:
```bash
pnpm docs:build
```

#### Using npm:

```bash
npm run docs:build
```

#### Using Yarn:

```bash
yarn docs:build
```

#### Using pnpm:

```bash
pnpm docs:build
```

2. ### Preview the Production Build:
#### Using npm:
``` bash
npm run docs:preview
```

#### Using Yarn:
```bash
yarn docs:preview
```
#### Using pnpm:
```bash
pnpm docs:preview
```

#### Using npm:

```bash
npm run docs:preview
```

#### Using Yarn:

```bash
yarn docs:preview
```

#### Using pnpm:

```bash
pnpm docs:preview
```

This will help verify that the documentation works as expected before deploying.

Expand Down
Loading