Markdownライブラリを使用する必要があるかどうかを知るにはどうすればよいですか?
-
07-07-2019 - |
質問
多くのGithubプロジェクトが Markdown を使用していることに気付きました。元々、このライブラリは、ユーザーがソースコードスニペットを含む可能性のあるコメントや投稿を追加できるStackOverflowなどのサイトでのみ必要だと考えていました。ただし、一部のアプリはそうではない場合でもMarkdownを使用しているようです。
Markdownは軽量のマークアップです もともとジョンによって作成された言語 グルーバーとアーロン・スワーツ 最大の可読性と <!> quot; publishability <!> quot;その入力と 出力フォーム。言語には多くの時間がかかります の既存の規則からの手がかり 電子メールでプレーンテキストをマークアップします。 マークダウンはマークアップされたテキストを変換します 有効で整形式のXHTMLへの入力 左向きの山かっこを置き換えます ( '<!> lt;')およびそのアンパサンド 対応する文字エンティティ 参照。
現在、ユーザーがコメントを追加できる機能を含むWebアプリを作成しています。コメントにソースコードが含まれていなくても、このためにMarkdownを使用する必要はありますか?
解決
Needing Markdownは、ソースコードを含めることができることとは関係ありません。これは、フォーマッタが使用できない場合でも読み取り可能な単純な形式でテキストをフォーマットするための単なる方法です。歴史的に、フォーラムソフトウェアはこれにBBコードを使用していましたが、これは多くのユーザーにとって非常に面倒であり、<!> quot; readable <!> quot;を提供しません。機能。
とにかく、この場合、自問する必要がある質問は次のとおりです。ユーザーがコメントをフォーマットできるようにしますか?はいの場合、いくつかのフォーマットライブラリが必要です。その場合、マークダウンは良い考えかもしれません。強調されたテキストをアスタリスクやアンダースコアで囲むなど、テキストのみの環境で人々がマークアップする傾向に沿って並んでいます。
HTMLマークアップをエンティティに置き換え、基本的にスクリプト攻撃を防止するため、何らかの保護もあります。
他のヒント
ユーザーが太字またはイタリックのテキストを入力できるようにする場合、または他のページへのリンクを使用する場合は、Markdownサポートを提供することをお勧めします。それがあなたがサポートしたいものであるかどうかはあなた次第ですが、それは有用です、IMO。