https://github.com/auros/docs.auros.nexus

Documentation for all the tools I make
https://github.com/auros/docs.auros.nexus

Last synced: 20 days ago
JSON representation

Documentation for all the tools I make

• Host: GitHub
• URL: https://github.com/auros/docs.auros.nexus
• Owner: Auros
• Created: 2024-02-06T05:23:10.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-04-02T18:38:37.000Z (9 months ago)
• Last Synced: 2024-12-16T20:44:41.172Z (24 days ago)
• Language: TypeScript
• Homepage: https://docs-chi-sandy.vercel.app
• Size: 36.2 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

This website is built using [Docusaurus](https://docusaurus.io/), 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= 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.