Skip to content

Commit

Permalink
Merge pull request #37 from panoratech/feat/docs-readme
Browse files Browse the repository at this point in the history
feat: add docs fixed
  • Loading branch information
naelob authored Oct 31, 2023
2 parents 76e2d8d + 8a24474 commit 160cfab
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 13 deletions.
22 changes: 10 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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=<Your GitHub username> yarn deploy
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.
1 change: 0 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "docs",
"version": "0.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
Expand Down

0 comments on commit 160cfab

Please sign in to comment.