quivr/docs
jbeltran73-2 dde5f2335e
Update vps_install.md for subdomain (#1589)
Changes so it reflects subdomain configuration

# Description

I've added subdomain configuration as many people use their domains
instead of creating a new domain root as the main one.
2023-11-06 09:53:12 +01:00
..
docs Update vps_install.md for subdomain (#1589) 2023-11-06 09:53:12 +01:00
src feat(docs): reworked the website (#1523) 2023-10-30 17:08:15 +01:00
static docs: ✏️ schema (#1537) 2023-10-31 19:20:07 +01:00
.gitignore feat(docs): added 2023-06-11 15:37:28 +02:00
babel.config.js feat(docs): added 2023-06-11 15:37:28 +02:00
docusaurus.config.js feat: 🎸 docs (#1561) 2023-11-02 14:42:39 +01:00
package.json feat: 🎸 docs (#1561) 2023-11-02 14:42:39 +01:00
README.md feat(docs): added 2023-06-11 15:37:28 +02:00
sidebars.js feat(docs): added 2023-06-11 15:37:28 +02:00
yarn.lock feat: 🎸 docs (#1561) 2023-11-02 14:42:39 +01:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.