Preview and Publish Pages
You have a variety of ways to manage your pages as you edit them.
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 should work for public, and unlisted pages.
When pages are created, they will go live instantly. If you do not want your page to go live, make sure to switch the "live" setting to off:
To unlist a published doc, go to the dropdown next to the save button and toggle Published? off.
There is no confirmation box when unlisting pages. Changes will take effect immediately.
Change Page URL
Click the dropdown next to the save button, then choose change page slug to edit the page URL. Don't forget to Save.
Hover over any page to reveal three options:
- Add Subpage
- Clone Page
- Delete Page
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.
The "+" icon is not available on subpages.
If the duplicate page is saved with the same Page Title, ReadMe will add "-1" to the page URL.
Original Page URL: /docs/introduction
Duplicate Page URL: /docs/introduction-1
You must confirm that you want to delete the page, as it we cannot recover it if deleted.
Drag a page to any other location, including other categories. Subpages will move with the page being dragged.
There is no confirmation box when reordering pages. Changes will take effect immediately.
Moving Categories Between Documentation and Reference
There is a button next to the category name that allows you to move categories between Documentation and Reference, as long as there are no API reference pages within the category.
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:
❯ ls -l total 24 -rw-r--r-- 1 jyowell staff 165 Mar 11 15:21 file-test.md -rw-r--r-- 1 jyowell staff 180 Mar 11 15:21 home.md -rw-r--r-- 1 jyowell staff 125 Mar 11 15:21 settings.md
We only accept files within a directory, but no subdirectories underneath that.
Markdown File Format
--- title: "files" excerpt: "these are my files" slug: "file-test" category: 6039419eee15f1005fb57099 --- This is body text for the page
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.
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:
$ rdme docs <directory name> --version="<version>" --key="<project_api_key>"
Updated 5 months ago