https://github.com/apiato/documentation

Full Documentation for Apiato
https://github.com/apiato/documentation

apiato documentation

Last synced: 14 days ago
JSON representation

Full Documentation for Apiato

• Host: GitHub
• URL: https://github.com/apiato/documentation
• Owner: apiato
• Created: 2017-11-03T16:56:20.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T00:42:59.000Z (2 months ago)
• Last Synced: 2024-12-09T20:25:27.898Z (24 days ago)
• Topics: apiato, documentation
• Language: MDX
• Homepage: https://apiato.io/
• Size: 75 MB
• Stars: 13
• Watchers: 6
• Forks: 36
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Security: docs/security/_category_.json

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.