https://github.com/fishjam-dev/fishjam-docs

Jellyfish documentation
https://github.com/fishjam-dev/fishjam-docs

Last synced: 3 months ago
JSON representation

Jellyfish documentation

• Host: GitHub
• URL: https://github.com/fishjam-dev/fishjam-docs
• Owner: fishjam-dev
• License: apache-2.0
• Created: 2023-02-28T11:20:30.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-15T16:30:25.000Z (about 1 year ago)
• Last Synced: 2024-05-16T09:49:17.515Z (about 1 year ago)
• Language: MDX
• Homepage: https://jellyfish-dev.github.io/jellyfish-docs/
• Size: 85 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> [!IMPORTANT]  

> This repository is archived.

>

> Check out our [documentation](https://docs.fishjam.io/) for the new [Fishjam](https://fishjam.io/).

# Fishjam docs

[![pages-build-deployment](https://github.com/fishjam-dev/fishjam-docs/actions/workflows/build_pages.yml/badge.svg)](https://github.com/fishjam-dev/fishjam-docs/actions/workflows/pages/pages-build-deployment)

The docs for the [Fishjam](https://github.com/fishjam-dev/fishjam).

You can read the docs here: https://fishjam-dev.github.io/fishjam-docs/

## Installation

```

npm install

```

## Local Development

```

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

## Versioning

We follow [the versioning system provided by docusaurus](https://docusaurus.io/docs/versioning)

To create a new docs version:

- make sure that `sidebars.js` and files inside `docs/` directory are up-to-date and ready to be frozen

- run `npm run docusaurus docs:version 1.0.0`

## Copyright and License

Copyright 2024, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

Licensed under the [Apache License, Version 2.0](LICENSE)