RevoGrid Documentation

Welcome to the RevoGrid documentation repository. This project uses VitePress to generate a static site for the RevoGrid documentation.

Introduction
Setup
Project Structure
Filling the Documentation
Contributing
License

Introduction

RevoGrid is a powerful data grid component for web applications. This repository contains the source files for the RevoGrid documentation site.

Setup

To set up the project locally:

Clone the repository:

git clone https://github.com/revolist/revogrid-docs.git
cd revogrid-docs

Install dependencies:
```
npm install
```
Run the local development server:
```
npm run dev
```
Build the static site:
```
npm run build
```

Project Structure

guide, demo: Contains the markdown files for the documentation.
.vitepress: Configuration for VitePress.
public: Static assets.

Filling the Documentation

Creating a New Page

Add a new markdown file in the docs directory:
```
guide/new-page.md
```

Write the content using Markdown:

# New Page Title

This is the content of the new page.

Update the sidebar navigation: Edit .vitepress/configs/sidebar/en.ts:

export const sidebarEn: DefaultTheme.Sidebar = {
 '/guide/': [
     {
      // other entries
      { text: 'New Page', link: '/new-page' }
    }]
  }

Markdown Syntax

Use Markdown to write the content. Here are some common elements:

Headings: #, ##, ###, etc.
Links: [link text](URL)

Code blocks:

```js
console.log('Hello, RevoGrid!');
```

Lists: -, *, or 1.

Contributing

We welcome contributions! To contribute:

Fork the repository.
Create a new branch:
```
git checkout -b feature-branch
```
Make your changes and commit them:
```
git commit -m 'Add new feature'
```
Push to the branch:
```
git push origin feature-branch
```
Create a Pull Request.

Please ensure your contributions follow our guidelines and include appropriate documentation updates.

For more information, visit the RevoGrid GitHub repository and the official website.


This `README.md` provides clear instructions on how to set up, fill, and contribute to the VitePress-based RevoGrid documentation. Adjust as needed to better fit the specific requirements of the project.

MattTheCuber/revogrid-docs