https://github.com/skapphq/skapp-docs

The official Skapp documentation.
https://github.com/skapphq/skapp-docs

Last synced: 4 days ago
JSON representation

The official Skapp documentation.

• Host: GitHub
• URL: https://github.com/skapphq/skapp-docs
• Owner: SkappHQ
• License: agpl-3.0
• Created: 2024-12-05T08:04:17.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-30T08:04:58.000Z (9 days ago)
• Last Synced: 2024-12-30T09:26:10.599Z (9 days ago)
• Language: TypeScript
• Homepage: https://docs.skapp.com
• Size: 9.82 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Skapp-docs

The official [Skapp](https://skapp.com/) documentation, built with [Docusaurus](https://docusaurus.io/).

### Installation

```

$ npm i

```

### Local Development

```

$ npm run 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

```

$ npm run 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.