リンクの使い方
この記事では、WSOFTDocsで公開されている記事からハイパーリンクを使用する方法について説明します
WSOFTDocsでは、MkDocsを使用します。これは、Pymdown解析エンジンを介して解析されるマークダウンをサポートします。
重要
リンク先のサイトで使用可能な場合は必ず、httpではなくhttpsから始まるUrlを使用してください。
リンクテキスト
リンクのテキストに含める単語はわかりやすいものにしましょう。
重要
リンクテキストとして「ここをクリック」などのテキストを使用しないでください。そのようなテキストはSEO対策として好ましくなく、リンク先の説明としても正確ではありません。
- 適切な例
詳しく知るには、WebSailing NX107.2の更新情報を参照してください。
- 不適切な例
詳しく知るには、この記事を参照してください。
別の記事へのリンク
別の記事へのリンクは、現在のドキュメントからの相対パスか絶対パスを指定することで実現できます。
-
記事を同じディレクトリの別の記事にリンクする場合:
\[link text](./docname.md) -
記事を現在のディレクトリのサブディレクトリにある記事にリンクする場合 :
\[link text](./directory/docname.md)
ブックマークリンク
現在の記事にある見出しへのブックマークリンクはハッシュ記号を使って、その後に見出しの語を小文字で続けます。日本語の場合は便宜上必要なidが英語で生成されます。idは生成してからわかります。
WSOFTDocs以外のページへのリンク
別のWSOFTのページにリンクする場合は、絶対URLを使用してください。 この方法で指定したリンクは、自動的にリンクに下線が引かれ、クリックすると新規タブで開くようになります。
結果
リンクに下線が引かれないようにするには、unnewtabクラスを使用してください。
結果
サードパーティのサイトへのリンク
記事を読みやすくするのためのもっとも良い方法は、別のサイトへのリンクを最小限に抑えることです。 サードパーティのサイトにリンクする必要がある場合は、次の方針に基づいて行なってください。
-
サードパーティの情報 説明する事項が外部の製品の情報である場合はサードパーティのコンテンツにリンクしてください。たとえば、WSOFTのサイトでWindowsの使用方法の説明はすべきでなく、Microsoftのサイトへのリンクを貼るべきです。WSOFTDocsでWindowsの使用方法を説明する必要がある場合、説明は最小限にとどめましょう。
-
リンクと責任 使用条件で否認しているとはいえ、サードパーティのコンテンツにリンクすることは、WSOFTがそのコンテンツを信頼していることやユーザーがその指示に従った場合にWSOFTにも責任があると捉えられることがあります。
-
情報の鮮度や正確性のレビュー 免責事項はありますが、できる限り最新かつ正確で関連性があって、リンクも正確なコンテンツへリンクすべきです。
-
移動の明確化 別のサイトに移動することをユーザーが認識できるようにしましょう。明確でない状況の場合には。適切な言い回しを使用してください。たとえば、「前提条件としてNET6.0が導入済みである必要があります。これはMicrosoftのサイトでダウンロードできます。」のように説明すべきです。WSOFTDocsでは外部のサイトへのリンクに自動的に下線が引かれます。
WSOFTについて