https://github.com/opensumi/docs

OpenSumi document website
https://github.com/opensumi/docs

docs gatsby opensumi

Last synced: 3 days ago
JSON representation

OpenSumi document website

• Host: GitHub
• URL: https://github.com/opensumi/docs
• Owner: opensumi
• License: mit
• Created: 2021-10-19T02:21:21.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T07:12:02.000Z (about 2 months ago)
• Last Synced: 2024-09-18T09:35:08.142Z (about 2 months ago)
• Topics: docs, gatsby, opensumi
• Language: TypeScript
• Homepage: https://opensumi.com
• Size: 37.8 MB
• Stars: 7
• Watchers: 19
• Forks: 34
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




# OpenSumi Documentation Website

✨ Powered by [OpenSumi Gatsby Theme](https://github.com/opensumi/gatsby-theme).

[![CI](https://github.com/opensumi/docs/actions/workflows/documentation.yml/badge.svg)](https://github.com/opensumi/docs/actions/workflows/documentation.yml)



This website is built using [gatsbyjs](https://www.gatsbyjs.com/), a modern static website generator.

## Installation

```console

yarn

```

## Local Development

```console

yarn start

```

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

## Build

```console

yarn build

```

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

## Deployment

```console

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.