dot-mirua place for dotfiles

documentation

How to use dot-miru

Turn your dotfiles into a readable profile and share it with a short URL. There are two ways to publish.

01

Publish right away

No contact or pull request is needed. Create a profile in the editor and publish it directly to the site database.

  1. Enter your name, environment, and dotfiles in the editor.
  2. Select “Publish profile.”
  3. Share the public URL that appears.
  4. Save the private editor URL somewhere safe.
Publish your dotfiles →

02

Join the top-page directory

For a permanent listing on the top page, publish the TOML on GitHub or Gist and request registration. Your profile will be available at /u/your-slug.

  1. Download dot-miru.toml from the editor.
  2. Publish the file in a GitHub repository or Gist.
  3. Open a pull request adding its raw HTTPS URL to profiles.toml.

Supported sources are raw.githubusercontent.com and gist.githubusercontent.com. Revision-pinned Gist raw URLs are normalized to follow the latest version.

Register in the directory with a PR ↗

03

Keep your editor URL safe

The first database publish creates a public URL and a private editor URL. The edit key after #key= is required to update or delete the profile.

Keep the editor URL private.

The edit key cannot be shown again, reissued, or recovered. The site stores only a hash of the key.

Open the editor URL to load, update, or delete the existing profile. The public URL is safe to share with anyone.

04

TOML and images

Only a name is required. Add a repository, summary, social accounts, machine details, dotfiles, and screenshots as needed.

  • Use public HTTPS URLs for images.
  • Enter account IDs—not full URLs—for GitHub and X.
  • Database-stored TOML is limited to 1 MB.
  • After replacing an image at the same URL, add a query such as ?v=2 to bypass caches.