> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleve.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Publishing

> Put docs and folders on your public profile, or publish them as Resources

Publishing makes your work public. You can publish a doc or folder to your **profile**, where anyone can read it and search engines can find it, or publish it to the **marketplace** as a Resource that other people add to their own workspace.

## Sharing vs publishing

| | Sharing | Publish to profile | Publish to marketplace |
| - | - | - | - |
| Who can open it | People you invite, and anyone with the link if you allow it | Anyone | Anyone can browse it and add a copy |
| Found by search engines | No | Yes | Listed on the marketplace |
| Others can edit your doc | If you make them editors | No | No, they get their own copy |
| Where it lives | Its normal address in Cleve | Your profile page | The marketplace |

Publishing doesn't change who you've shared a doc with, and unpublishing doesn't remove anyone's access. See [Sharing docs and folders](https://docs.cleve.ai/features/collaboration.md).

## Set your username

Your profile address uses your username, so set one before you publish:

1. Open **Settings → General**.
2. Under **Username**, enter a name and click **Save**.

Usernames are 3 to 30 characters, start with a letter, and use only letters, numbers, hyphens, and underscores. A tick shows when the name is available. Once it's saved, **View profile** opens your public profile.

## Publish a doc or folder to your profile

**1. Open the Share dialog**

For a doc, open it and click **···** → **Share**. For a folder, click **···** next to it in the sidebar and choose **Share**.

**2. Expand Publish**

At the bottom of the dialog, click **Publish**.

**3. Turn on Publish to profile**

Switch on **Publish to profile**. The line below shows where it will appear.

Only a doc's owner can publish it. A folder can be published by its owner or, for a workspace folder, by any member of the workspace.

Publishing a folder publishes the docs directly inside it, and they appear together on your profile.

### Your public profile

Your profile is at `app.cleve.ai/user/your-username`. It shows your name and photo and lists everything you've published, with folders first and then docs, each with its publish date.

Visitors don't need a Cleve account. Each published doc has its own page with its title, your name, and the date. The text loads with the page, so it reads well in any browser, link preview, or AI tool. Formatting, images, diagrams, and [interactive blocks](https://docs.cleve.ai/features/interactive-blocks.md) all display, and interactive blocks work as they do in Cleve.

Published docs are read-only. Changes you make to a published doc show on your profile as you make them.

### Search engines

* **Published docs** can be indexed by search engines. If a published doc is also shared by link, search engines are pointed to its profile page.
* **Docs shared only by link** are marked so search engines don't index them. People with the link can read them, but nobody can find them by searching.

### Unpublish

Open the Share dialog, expand **Publish**, and switch off **Publish to profile**. The doc or folder disappears from your profile and its public page stops working. Anyone you've shared it with keeps their access.

### Publish with the API

You can also publish and unpublish docs from the [REST API](https://docs.cleve.ai/developers/api.md) with `POST` and `DELETE` on `/api/v1/notes/{noteId}/publish`. The API calls docs "notes".

## Publish to the marketplace

Publishing to the marketplace turns a doc or folder into a **Resource**: a copy that anyone can find and add to their own workspace.

* **A doc:** in the Share dialog, expand **Publish** and click **Publish** next to **Publish to marketplace**. Give it a name and an optional short description, then click **Publish**.
* **A folder:** in the folder's Share dialog, expand **Publish** and click **Publish to marketplace**. Fill in the name, description, and category, then create it. The Resource includes the folder's docs and subfolders.

You can also make a Resource from the Marketplace with **New resource**. See [Resources marketplace](https://docs.cleve.ai/features/resources.md#publish-your-own-resource).

A Resource is a snapshot taken when you publish it. Later changes to your doc don't change the Resource, and people who add it get their own copy, not access to your doc.

## Related

> **[Sharing docs and folders](https://docs.cleve.ai/features/collaboration.md)**
>
> Invite people and set link access.

> **[Resources marketplace](https://docs.cleve.ai/features/resources.md)**
>
> Browse, add, and publish Resources.

> **[Interactive blocks](https://docs.cleve.ai/features/interactive-blocks.md)**
>
> HTML blocks and widgets in your docs.

> **[REST API](https://docs.cleve.ai/developers/api.md)**
>
> Publish docs programmatically.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.