Publish a document
This page explains how to publish your edits as a public site that anyone on the internet can view.
Working content and the published version
Monjiro keeps what you are editing (the working content) separate from what readers see (the published version). Editing does not change the public site until you publish.
If you edit after publishing, "Unpublished changes" appears under "Versions" in the right panel.
Publish
- Use "Preview" at the top right of the editor to check how it will look when published.
- Click "Publish" at the bottom of the "Document" tab in the right panel.
- Choose how to publish, enter a note if needed, and click "Publish".
| How to publish | Description |
|---|---|
| Publish as a new version | Kept in the publish history as a new version (v1, v2, ...). |
| Overwrite the latest version | Replaces the content of the latest version. Use it for changes not worth keeping in the history, such as fixing typos. |
The note is shown in the list of versions (for example, "Added step 3").
Public URL
The URL of your public site is shown under "Public URL" in the right panel. Click the URL to change the subdomain (the first part of the URL).
- A subdomain can use lowercase letters, numbers and hyphens (3β63 characters; it cannot start or end with a hyphen).
- You cannot use a subdomain used by another document or a reserved subdomain.
- If you change the URL of a published document, links you shared before stop working.
Hide a page
You can hide individual pages, such as pages in progress or pages you do not want to publish yet. Hidden pages stay in the document but are not shown on the public site.
- In the editor, open the page you want to hide.
- Open the "Page" tab in the right panel.
- Under "Visibility", turn on "Hide this page".
- Publish the document. The hidden setting takes effect when you publish.
Hidden pages are handled as follows.
- Child pages are hidden too: All child pages under a hidden page are hidden. Even if a child page has the setting turned off, it is not shown on the public site while its parent is hidden.
- Not shown on the public site: They do not appear in the page tree, breadcrumbs or page tree blocks. Opening the URL directly shows "Page not found".
- Excluded from search and the AI chat: They are not listed in the sitemap, and the readers' AI chat does not use the content of hidden pages in its answers.
- Mark in the editor: In the page list on the left, hidden pages have a hidden mark (an eye with a slash) on their right. Pages hidden because their parent is hidden show a faded mark.
- Preview: Hidden pages are not shown in the page list and similar places, but you can check their content by opening them in the preview.
The first page (the root page) cannot be hidden because it is the entrance to the public site. To make the whole document unavailable, use "Unpublish" below.
Show in search engines
You can choose whether your public site appears in search results on Google and other search engines. By default, it is not listed. Turn it on if you want people to find your public site through search.
- In the editor, open the "Document" tab in the right panel.
- Under "Search engines", turn on "Show in search engines".
This setting takes effect immediately, without publishing.
- When it is off: The public site is marked so that search engines do not list it (noindex). Anyone who knows the URL can still view the public site.
- When access is restricted: Documents with access restrictions by IP address or email address are not listed even if this is on.
- With a custom domain: Search results show the URL of your custom domain (for example, docs.example.com).
- Preview and embedded chat: The editor's preview and AI chats embedded in other sites never appear in search results, regardless of this setting.
Sitemap (sitemap.xml)
When the site is set to be listed in search engines, a list of published pages (a sitemap) is available at /sitemap.xml on your public site's URL (for example, https://docs.example.com/sitemap.xml). Search engines find pages through the sitemap.
- The sitemap location is also announced to search engines in /robots.txt.
- The sitemap is not published when the site is set not to be listed or when access is restricted.
- When you add or delete pages and publish, the sitemap is updated automatically.
Even after you turn it on, it can take from a few days to a few weeks to appear in search results, depending on the search engine. To get listed sooner, submit your sitemap URL (/sitemap.xml) to a tool such as Google Search Console.
Unpublish
Click "Unpublish" in the right panel, and readers can no longer view the document. The history of published versions is kept, and you can publish again later.