An unlisted page is published, but only reachable by its URL: it appears in no listing, feed, sitemap or search index. Handy to share a draft or a page with a few people.

This is not access control. Anyone with the URL can read the page, and so can anyone it is forwarded to. Do not use it for confidential content.

Creating one

  1. Generate a token:

    gramr token

  2. Put it in the note:

    ---
gramr:
  publish: unlisted
  site: blog
  section: articles
  token: r3jrg5kmwelyqn6qgxeb
title: Draft for review
---

  3. Publish. The page is at /articles/r3jrg5kmwelyqn6qgxeb/.

The token is stored in the note, so the URL stays the same from any computer and when you rename the note or change its title. To revoke a link, change the token.

What gramr does

  • The token is the file name of the page. slug, path and url are rejected on unlisted notes: Zola would use them to build a readable URL.
  • The page is hidden by setting hidden: true, include_in_feeds: false and in_search_index: false, overwriting any value set in the note. Zola ≥ 0.23 is required.
  • Links from public pages to unlisted pages are removed, since they would reveal the URL. Links between unlisted pages are kept.

A custom template that lists every page without checking hidden would still expose unlisted pages: check your templates.

Tokens

gramr token gives 20 random characters among a-z and 2-7 (100 bits). Any token of at least 16 characters among a-z and 0-9 is accepted.