Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
# Docusaurus 2
# Watermelon Docs

This directory is a brief example of a [Docusaurus](https://v2.docusaurus.io) site that can be deployed to Vercel with zero configuration.
## About Watermelon

## Deploy Your Own
Welcome!
[Watermelon Tools](https://watermelontools.com) is a company with a mission to make developing as a team easier.
We started in February 2022 with a [VSCode extension](https://marketplace.visualstudio.com/items?itemName=WatermelonTools.watermelon-tools) and have built on it.
We are now focused on helping you deliver PRs with business value with our [GitHub App](https://github.com/marketplace/watermelon-context).

Deploy your own Docusaurus project with Vercel.
### How to use

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/vercel/tree/main/docusaurus-2&template=docusaurus-2)
You will first have to register in [our app](https://app.watermelontools.com). This will create a token and sessions, and will allow you to connect your services.

_Live Example: https://docusaurus-2-template.vercel.app_
#### VSCode Extension

### How We Created This Example
You will also have to login on [VSCode](https://app.watermelontools.com/vscode) or [VSCode Insiders](https://app.watermelontools.com/vscode-insiders).
We also work with [VSCodium](https://app.watermelontools.com/vscodium), the libre version.

To get started with Docusaurus on Vercel, you can use the [Docusaurus CLI](https://v2.docusaurus.io/docs/installation#scaffold-project-website) to initialize the project:
#### GitHub App

```shell
npx create-docusaurus@latest my-website classic
```
You can install [the GitHub App](https://github.com/marketplace/watermelon-context) from the markeplace, and we will start writing to all of your PRs with any info we find.

### Contributing

We are a source available company. You can find all of our repos [in GitHub](https://github.com/watermelontools).

This is the repo for our API Docs.

The `main` branch gets deployed on [https://docs.watermelontools.com](https://docs.watermelontools.com)
Loading