https://github.com/neutron-org/neutron-docs

https://github.com/neutron-org/neutron-docs

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/neutron-org/neutron-docs
• Owner: neutron-org
• Created: 2022-07-14T06:55:57.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T15:14:35.000Z (7 months ago)
• Last Synced: 2024-05-29T01:05:56.245Z (7 months ago)
• Language: JavaScript
• Size: 37.7 MB
• Stars: 18
• Watchers: 5
• Forks: 25
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-ccamel - neutron-org/neutron-docs - (JavaScript)

README

        
# Website

This website is built using [Docusaurus 2](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.