使い方
dot-miru の使い方
dotfiles の内容を読みやすいプロフィールにして、短いURLで共有できます。公開方法は2つあります。
01
すぐに公開する
連絡やPRは不要です。エディターからプロフィールを作成し、サイトのデータベースへ直接公開できます。
- エディターで名前や環境、dotfiles の説明を入力します。
- 「プロフィールを公開」を押します。
- 表示された公開URLを共有します。
- 編集URLは安全な場所へ保存します。
02
トップページの一覧に掲載する
継続的にトップページへ掲載したい場合は、TOMLをGitHubまたはGistで公開し、登録を依頼します。この方法ではプロフィールが /u/あなたのslug で公開されます。
- エディターから dot-miru.toml をダウンロードします。
- GitHubリポジトリまたはGistでファイルを公開します。
- Raw HTTPS URLを profiles.toml に追加するPRを送ります。
対応する取得元は raw.githubusercontent.com と gist.githubusercontent.com です。Gistの版番号付きRaw URLは自動的に最新版を指す形式へ変換されます。
PRで一覧へ登録する ↗03
編集URLをなくさない
データベースへ初めて公開すると、公開URLと編集URLが作られます。編集URLの #key= 以降に含まれる編集キーは、プロフィールの更新と削除に必要です。
編集URLは非公開にしてください。
編集キーの再表示・再発行・復旧には対応していません。サイトにはキーそのものではなくハッシュだけが保存されます。
編集URLを開くと既存の内容がエディターへ読み込まれ、更新または削除できます。公開URLは誰に共有しても構いません。
04
TOMLと画像について
必須項目は名前だけです。リポジトリ、紹介、SNS、マシン情報、複数のdotfileとスクリーンショットを必要な分だけ追加できます。
- 画像には公開HTTPS URLを使用してください。
- GitHubとXにはURLではなくアカウントIDを入力します。
- データベースに保存できるTOMLは1MBまでです。
- 同じ画像URLの内容を差し替えた場合は、?v=2 などを付けるとキャッシュを回避できます。