リンクの使い方

この記事では、WSOFTDocsでホストされている記事からハイパーリンクを使用する方法について説明します。いくつか規則がありますが、リンクは同じサイト内でも、外部のサイトやURL上のコンテンツでも、どこへでもMarkdownに簡単に追加できます。

WSOFTDocsでは、MkDocsを使用します。これは、Jinja2解析エンジンを介して解析されるマークダウンをサポートします。 すべてのドキュメントはGitHubでホストされ、そこで編集できるように、このマークダウンはGitHubFlavoredMarkdownと互換性があります。 Markdown拡張機能を通じて、その他の機能が追加されています。

リンクテキスト

リンクのテキストに含める単語はわかりやすいものにしましょう。

• 適切な例

詳しく知るには、WebSailing NX107.2の更新情報を参照してください。

• 不適切な例

詳しく知るには、この記事を参照してください。

別の記事へのリンク

別の記事へのリンクは、現在のドキュメントからの相対パスか絶対パスを指定することで実現できます。

• 記事を同じディレクトリの別の記事にリンクする場合:\[link text](/docname.md)

• 記事を現在のディレクトリのサブディレクトリにある記事にリンクする場合 :\[link text](./directory/docname.md)

ブックマークリンク

現在の記事にある見出しへのブックマークリンクはハッシュ記号を使って、その後に見出しの語を小文字で続けます。日本語の場合は便宜上必要なidが英語で生成されます。idは生成してからわかります。

[Test](#test)

WSOFTDocs以外のページへのリンク

別のWSOFTのページにリンクする場合は、絶対URLを使用してください。

[link text](https://wsoft.ws/)

サードパーティのサイトへのリンク

ユーザー体験のための最も良い方法は。別のサイトへのリンクを最小限に抑えることです。しかし、サードパーティのサイトにリンクする必要がある場合は、次の情報に基づいて行なってください。

• サードパーティの情報 共有する情報がサードパーティの情報である場合はサードパーティのコンテンツにリンクしてください。例えば、WSOFTのサイトでWindowsの使用方法の説明はしません。これは、Microsoftが説明するべきことです。必要があれば、WSOFTDocsでWindowsの使用方法を説明することができますが、それは必要最小限にすべきです。

• 責任の否認 サードパーティのコンテンツに対してWSOFTはいかなる責任も否認します。サードパーティのコンテンツにリンクすることは、WSOFTがそのコンテンツを信頼していること、またユーザーがその指示に従った場合のWSOFTの責任を受け取られうる可能性があります。

• 情報の鮮度や正確性のレビュー 上の指針があったとしても、できる限り最新かつ正確であり、関連性があって、リンクも正確なコンテンツへリンクすべきです。

• 移動の明確化 別のサイトに移動することをユーザーが認識できるようにしましょう。それが明確でない状況の場合には。適切な言い回しを使用してください。例えば、「前提条件として.NET6.0が導入済みである必要があります。これはMicrosoftのサイトでダウンロードできます。」のような形式です。