https://github.com/futurelogxyz/futurelog-docs

Futurelog Docs
https://github.com/futurelogxyz/futurelog-docs

Last synced: about 2 months ago
JSON representation

Futurelog Docs

• Host: GitHub
• URL: https://github.com/futurelogxyz/futurelog-docs
• Owner: futurelogxyz
• License: mit
• Created: 2023-08-02T06:55:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-14T09:25:52.000Z (over 1 year ago)
• Last Synced: 2023-08-14T10:38:24.296Z (over 1 year ago)
• Language: JavaScript
• Homepage: https://docs.futurelog.xyz
• Size: 2.38 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# futurelog-docs

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.