Pick a handle#
Your handle is the name every public URL of yours sits under. You choose it once, the first time you publish.
- 3–30 characters
- lowercase letters, numbers and hyphens
- no hyphen at the start or end
Handles cannot be changed yet, so choose one you would still want in a
year. Some names are reserved (admin, api, docs, www and similar).
Publish the folder#
From the dashboard, open Collections, choose a folder, and give it a name. That name becomes part of the URL:
markloom.app/u/<handle>/<collection>
The collection name follows the same rules as a handle, up to 40 characters.
Publishing does two things: it records which folder the URL points at, and it sets the folder's Google Drive sharing to "anyone with the link" so the pages can be read by visitors who are not signed in.
A published site is genuinely public, and search engines can index it. There is no private or password-protected publishing yet. Do not publish an internal handbook, runbooks, or anything under NDA.
Which files become pages#
Every .md file directly inside the folder becomes a page — except
files whose name starts with _. Those are settings and notes:
_config.md, _toc.md, _redirects.md, and anything else you want to
keep out of the site.
A page's address comes from its file name:
| File | URL ends in |
|---|---|
getting-started.md | /getting-started |
Getting Started.md | /getting-started |
01 — Intro.md | /01-intro |
Subfolders are ignored. Keep the folder flat.
Seeing your changes#
Save a file and the published page updates within a few seconds. If you edit the folder outside Markloom — in Drive directly — changes appear within about five minutes.
Unpublishing#
Unpublish from the collection's page in the dashboard. The public URLs stop resolving and the folder's "anyone with the link" permission is removed. Your files are untouched.
Google will refuse to remove the folder's public permission if the folder contains items Markloom cannot manage — files, shortcuts or subfolders created directly in the Drive interface. Delete those in Drive first, including emptying them from Drive's trash, then try again. Markloom will tell you when this is what happened.