RomanNum3ral
/
vert
mirror of https://github.com/VERT-sh/VERT.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[no ci] docs: add index at the top of each page

This commit is contained in:
azurejelly 2025-10-16 10:00:15 -04:00
parent 93c98d9d49
commit f747f38415
No known key found for this signature in database
GPG Key ID: 78C7CB2FBB62D96D
3 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/DOCKER.md
View File

@ -2,6 +2,9 @@
This file covers how to run VERT under a Docker container.
- [Manually building the image](#manually-building-the-image)
- [Using an image from the GitHub Container Registry](#using-an-image-from-the-github-container-registry)
### Manually building the image
First, clone the repository:
```shell

6
docs/FAQ.md
View File

@ -2,6 +2,12 @@
This file covers frequently asked questions.
- [Why VERT?](#why-vert)
- [What happens with video files?](#what-happens-with-video-files)
- [Can I host my own video file converter?](#can-i-host-my-own-video-file-converter)
- [What about analytics?](#what-about-analytics)
- [What libraries does VERT use?](#what-libraries-does-vert-use)
### Why VERT?
**File converters have always disappointed us.** They're ugly, riddled with ads, and most importantly; slow. We decided to solve this problem once and for all by making an alternative that solves all those problems, and more.

12
docs/GETTING_STARTED.md
View File

@ -2,6 +2,12 @@
This file covers how to get started with VERT.
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running Locally](#running-locally)
- [Building for Production](#building-for-production)
- [Using Docker](#using-docker)
### Prerequisites
Make sure you have the following installed:
- [Bun](https://bun.sh/)
@ -35,4 +41,8 @@ PUB_VERTD_URL=https://vertd.vert.sh # default vertd instance
To build the project for production, run `bun run build`.
This will build the site to the `build` folder. You should then use a web server like [nginx](https://nginx.org) to serve the files inside that folder.
This will build the site to the `build` folder. You should then use a web server like [nginx](https://nginx.org) to serve the files inside that folder.
### Using Docker
Check the dedicated [Docker](./DOCKER.md) page.