You have a variety of ways to manage your pages as you edit them.

# Preview Page

You can preview a page by clicking on the preview page icon next to the save button. It will open up the page in a new tab, and works for Public and Hidden (unlisted) pages.

# Publish Pages

When pages are created, they will go live instantly. If you do not want your page to go live, make sure the page is set to **Hidden**.

# Hidden Pages

To unlist a published doc, go to the Public/Hidden dropdown and ensure that it's set to **Hidden**.

❗

️ Caution

There is no confirmation box when unlisting pages. Changes will take effect immediately.

📘



Hidden pages are hidden from the site navigation, but users with direct links will still be able to access the pages.

# Change Page URL

Click the three dot menu above your page's title and select the **Edit Metadata** option. The **Page Slug** section is located at the bottom of the Edit Metadata pop-up menu, where you can edit the page URL. Don't forget to hit **OK** to save the change.

# Page Options

Hovering over any page reveals two options:

• A three dot menu where you can **duplicate** the page, **move** the page to another category, or **delete** the page. If the page has any related subpages, you'll need to move or delete the subpages in order to delete the page

• A plus icon which allows you to add a related **Subpage**

## Add Subpage

Subpages are nested within the parent page where the "+" icon was clicked. To create a regular page, click the "+" icon next to the Category name.

📘

Subpages

The "+" icon is not available on subpages.

## Clone Page

If the duplicate page is saved with the same Page Title, ReadMe will add "-1" to the page URL.

Example: Original Page URL: /docs/introduction Duplicate Page URL: /docs/introduction-1

## Delete Page

You must confirm that you want to delete the page, as it we cannot recover it if deleted.

# Reorder Page

Press and hold to drag a page to any other location, including other categories, and then drop it in its desired location. Subpages will move with the page being dragged.

You can also use the **Move to** function located in the three dot menu next to each page to move a page or subpage between categories.

❗

️ Caution

There is no confirmation box when reordering pages. Changes will take effect immediately.

# Moving Categories Between Documentation and Reference

There is a three dot menu next to each category name. Within that menu there's an option to **Move to API Reference **if you're in the Guides section and **Move to Guides** if you're in the API Reference section.

# Using the ReadMe Docs API

You can also manage your docs using our [Docs API](🔗), which allows you to return, update, delete, create, and search documentation pages.

# Syncing ReadMe Docs with CLI

Our [rdme CLI tool](🔗) can help sync your Markdown docs. This is useful for CI, or customers who may keep their documents hosted in a repository. There are a few things to remember when sync'ing your Markdown docs with rdme:

## Markdown Directory Format

Make sure you're using a flat directory structure:

We only accept files within a directory, but no subdirectories underneath that.

## Markdown File Format

Make sure each file has the following required header fields in the above format: **title**, **slug**, and **[category](🔗)**. You can add other headers too such as `hidden` (boolean) to hide your document when sync'ing. Please visit <https://docs.readme.com/reference/updatedoc> for more header fields.

🚧

File duplication

Make sure that your **slug** matches the actual Markdown file name. If my page slug is **file-test** then the file name itself will need to be named **file-test.md** If the slugs differ from the file name, we will upload a new file and cause duplicates!

## File sync commands

Use the following commands to sync your files: