https://github.com/defanglabs/defang-docs

Documentation for the Defang Opinionated Platform
https://github.com/defanglabs/defang-docs

Last synced: about 2 months ago
JSON representation

Documentation for the Defang Opinionated Platform

• Host: GitHub
• URL: https://github.com/defanglabs/defang-docs
• Owner: DefangLabs
• Created: 2023-06-16T22:07:03.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-22T18:27:19.000Z (7 months ago)
• Last Synced: 2024-05-22T19:42:38.479Z (7 months ago)
• Language: TypeScript
• Homepage: http://docs.defang.io/
• Size: 19.2 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```

$ npm install

```

Make sure that you've cloned the `defanglabs/defang` repo and `defanglabs/samples` repo in sibling directories.

```

$ git clone https://github.com/DefangLabs/defang.git ../defang 

$ git clone https://github.com/DefangLabs/samples.git ../samples

```

### Build

```

$ npm run build

```

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

### Local Development

```

$ npm run start

```

This command starts a local development server and opens up a browser window. 

### 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.