HackMDのメタデータに重要な変更が迫っています!準備をお願いします! | HackMD Blog
June 12, 2023

HackMDのメタデータに重要な変更が迫っています!準備をお願いします!

elek
elek
雜而不精的家政媽媽桑

Read this post in English or 中文

こんにちは、HackMDコミュニティの皆様、

お知らせがあります!HackMDでは、常にお客様の体験を向上させ、高度な機能を提供するために努力しています。この取り組みの一環として、ノート内でメタデータ(タイトルとタグ)の扱い方に重大な変更を導入する予定です。初めは少し混乱を招くかもしれませんが、私たちは皆様をご案内し、スムーズに適応するお手伝いをいたします。

変更の理由

以前は、メタデータはノート自体に保存されていました。このアプローチにはいくつかの欠点がありました。たとえば、メタデータの変更ごとにノート自体が変更され、不必要な通知がトリガーされるというものです。

皆様のフィードバックを聞き、これらの問題に対処し、複数のノートに対するメタデータの一括編集などの機能を導入するために、これらの変更を行っています。これらの変更により、バックリンクなどの新機能にも一歩近づくことができます。

変更内容

  • メタデータはHackMDに保存され、ノート自体には保存されません。
  • エディタには、タイトルとタグを編集するためのフィールドがあります。
  • タイトルとタグ以外のメタデータは、ノートの「設定」で設定することができます。
  • プレゼンテーションモードのテーマなどは、「共有」メニューのプレゼンテーションモードで設定できます。

影響を最小限に抑えるための移行方針

混乱を最小限に抑えるために、新しいメタデータのデフォルト値を導出するための移行方針を実施しました。ただし、これらの方針によりいくつかの問題が発生する可能性があることにご注意ください。具体的には、次のように動作します。

タイトルの移行

  • YAMLのフロントマターにタイトルが設定されている場合、そのタイトルがノートの新しいタイトルとして採用されます。
  • YAMLのフロントマターにタイトルが設定されていない場合で、ノート内に少なくとも1つのH1ヘッダーが存在する場合、最初のH1ヘッダーが新しいノートのタイトルになります。
  • YAMLのフロントマターにタイトルが設定されておらず、ノート内にH1ヘッダーが存在しない場合、ノートは「無題」というタイトルになります。

タグの移行

  • YAMLのフロントマターにタグが設定されている場合、それがノートの新しいタグとして採用されます。
  • YAMLのフロントマターにタグが設定されていない場合で、H6ヘッダーを使用してタグが設定されている場合、H6ヘッダーで設定されたタグがノートの新しいタグとして考慮されます。
  • YAMLのフロントマターやH6ヘッダーのいずれにもタグが見つからない場合、ノートにはタグがありません。

タイトルとタグ以外のメタデータ

その他のメタデータはそのまま移行されます。

「変な状況」を緩和するための提案

私たちは、移行中にノートの表示にいくつかの特異点が現れる可能性があることを理解しています。以下に、これらの変更をスムーズに行うためのいくつかの提案をご紹介します。

1. タイトルの重複の処理

H1ヘッダーを使用してタイトルが設定されたノートの場合、新しいタイトルフィールドとH1があるノート内に重複した文字列が表示されることがあります。

この場合、私たちは表示モードでタイトルとタグを折りたたんで表示していますが、重複を避けるためにタイトルに使用したH1ヘッダーを手動で削除することをおすすめします。

2. H6タグの管理

以前は、H6タグは表示モードで表示されていましたが、引き続きサポートされます。ただし、H6タグへの新しい編集は反映されません。

タグの追加や削除には、タグフィールドやノートリスト(開発中で近日公開予定)を使用することをおすすめします。そこでは一度に複数のノートのタグを便利に編集できます。

表示モードにはタグ用のスペースがあるため、H6タグヘッダーも表示されるため、後者は重複している可能性があり、削除することを検討されるかもしれません。

私たちはお手伝いします 🙌

これらの変更への適応には時間がかかる場合があることを理解しており、私たちのサポートチームはいつでもお手伝いいたします。ご質問やご不明な点、さらなるご案内が必要な場合は、サポートチャンネルからお問い合わせください(emailDiscord)。喜んでお手伝いいたします。

この移行期間中のご理解とご協力に感謝いたします。これらの変更により、HackMD内での新たな可能性や機能の向上が実現されます。

コミュニティの大切なメンバーであり、進化を共に遂げてくださる皆様に感謝いたします。

楽しい執筆を!

HackMDチームより