An open API service indexing awesome lists of open source software.

https://github.com/zvec-ai/zvec-web

zvec-web is the official web frontend and documentation portal for Zvec
https://github.com/zvec-ai/zvec-web

Last synced: about 2 months ago
JSON representation

zvec-web is the official web frontend and documentation portal for Zvec

Awesome Lists containing this project

README

          

# Zvec Website

This is a Next.js application generated with [Create Fumadocs](https://github.com/fuma-nama/fumadocs).

[Fumadocs](https://fumadocs.dev) is great!

## Instructions

### 1. Install Dependencies

```bash
npm install
```

### 2. Run the Development server

```bash
npm run dev
```

Open with your browser to see the result.

### 3. Build and Deploy

Build [API reference](./api-reference/README.md) first, then build and deploy the website.

```bash
npm run build
npx serve@latest out
```

## Structure

Documentation is written in Markdown files located in the **/content/docs/** directory.

**Fumadocs** automatically generates both the sidebar navigation and the table of contents based on the directory structure. To customize the order of pages, use a **meta.json** file within the relevant directory.

The [API Reference](./api-reference/README.md) is automatically generated from the Zvec source code and is placed in the **api-reference/** directory.