From 8a2447437974084d77eceb54fdba4b800e53e413 Mon Sep 17 00:00:00 2001 From: nael Date: Tue, 31 Oct 2023 14:26:29 +0100 Subject: [PATCH] feat: add docs fixed --- docs/README.md | 22 ++++++++++------------ docs/package.json | 1 - 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/README.md b/docs/README.md index aaba2fa1e..bf9b72f72 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,41 +1,39 @@ -# Website - -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +# Panora Documentation ### Installation ``` -$ yarn +pnpm install ``` -### Local Development +### Build ``` -$ yarn start +pnpm run build ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Build +### Local Development ``` -$ yarn build +pnpm run start ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. ### Deployment Using SSH: ``` -$ USE_SSH=true yarn deploy +USE_SSH=true yarn deploy ``` Not using SSH: ``` -$ GIT_USER= yarn deploy +GIT_USER= 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. diff --git a/docs/package.json b/docs/package.json index f34c9d0d9..d8210785e 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,7 +1,6 @@ { "name": "docs", "version": "0.0.0", - "private": true, "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start",