あなたが ソフトウェアエンジニア 、生産性を高めるために環境を改善するために多くの時間を費やしたことでしょう。お気に入りのIDEがあります。お気に入りのデバッガーがあります。お気に入りのパフォーマンス監視ツールがあります。しかし、ドキュメント、マニュアル、レポートを作成するためのツールはどうでしょうか。結局のところ、書くことはあなたの時間の取るに足らない量を要しますね?確かに、あなたのライティングツールについて真剣に取り組む時が来ました。
そしてそれを覚えておきましょう あなたは技術的です 、したがって、WYSIWYGエディターが最適なオプションである場合とそうでない場合があります。メニュー、ツールバー、リボンをナビゲートしてテキストをフォーマットする必要はありません(または好きです!)。
詳細が記載されたハッキングされたクレジットカード番号
では、代わりに、すべての書式設定スタイルを単純なインライン構文としてテキストに簡単に追加して、完全に書式設定されたテキストを生成できるとしたらどうでしょうか。
まあ、実際には、できます。それは マークダウン それがこのチュートリアルのすべてです。
ワードプロセッシングソフトウェアは、非常に幅広いユーザーとユースケースを満たすように作成されているため、あらゆる種類の機能を提供する必要があります。しかし、明らかに、その機能のごく一部だけが個々のユーザーに関連している可能性があります。そして、単にドキュメントを作成したい(そしてマーケティングパンフレットやポスターをデザインする必要がない)ほとんどのユーザーにとって、利用可能な多くのオプションのごく一部が関連しています。
実際、Microsoftは、数年前にMicrosoft Wordのユーザーインターフェイスを「リボン」と呼ばれる別個の機能グループに再設計したときに、これを明確に認識しました。それでも興味深いことに、ほとんどのユーザーは、新しいインターフェースが以前のインターフェースよりも混乱し、ナビゲートするのが難しいと感じたと言うでしょう。
実際、使いやすさと生産性に関しては、多いほど少ない場合があります。
それに直面して、あなたはソフトウェアエンジニアであり、グラフィックデザイナーではありません。そのマニュアル、技術文書、またはレポートを作成して、それで済ませたいだけです。見出し、箇条書きまたは番号付きリスト、コードブロックなど、いくつかの基本的な書式設定機能に満足して満足できます。そして、そうそう、いくつかのフォントフォーマット(太字、斜体など)も役立ちます。それについてです。 (そして男、あなたがそれをすることができれば 私達 、それは本当に素晴らしいでしょう!)
Markdownを入力します。
Markdownとは何ですか?
ジョン・グルーバー (技術の第一人者とインターネット活動家からの多大な貢献を伴う アーロン・スワーツ )2004年にMarkdown言語を作成しました 目標 「読みやすく、書きやすいプレーンテキスト形式を使用して記述し、オプションで構造的に有効なXHTML(またはHTML)に変換する」ことを可能にします。
マークダウンは、タグやフォーマット指示でマークアップされているように見えることなく、そのまま読めるように設計されています(RTFやHTMLなどのマークアップ言語でフォーマットされたテキストとは異なり、作成や未加工のフォーマットでの読み取りが困難です。 )。
Markdownを使用すると、読みやすく、書きやすいプレーンテキスト形式を使用して書き込むことができ、構造的に有効なHTMLに変換できます。したがって、完全に正確に言うと、 マークダウンは本当に2つのことです :
Markdownには、いくつかのシンプルで、かなり直感的で、使いやすい構文規則が組み込まれています。特に、これらの基本的な構文規則を学習して使用する必要がないソフトウェアエンジニアとしてのあなたにとって、Markdownは、実際に、書きたいものとそれを書くことの間の抵抗が最も少ないパスになる可能性があります。
クリスタル(プログラミング言語)
マークダウンは簡単に習得できます。超簡単。あなたは5分で基本を学ぶことができ、それはすぐに第二の性質になります。そして、CSSとCSSプリプロセッサの関係と同じように、使用する量は少なくても多くてもかまいません。
あらゆる種類のプレーンテキストの記述規則に慣れている場合は、リストを作成するための文の先頭にある数字やダッシュ、強調するための単語の前後のアスタリスクなど、いくつかのマークダウン規則にすでに慣れているかもしれません。オン。したがって、たとえば、イタリックで何かを表示する場合は、*this*
のようにアスタリスクでラップします。 (this
のような不格好なHTML構文とは対照的です)。
同様に、次のようにjQueryを使用して、コンテナに「#」プレフィックスを追加するだけでH1見出しを指定できます(たとえば、コンテナに Initiate コンテナのIDを使用して、 開始するためのさらなるヘルプについては、オンラインで多くのMarkdownチュートリアルがあり、 マークダウンの概要 John Gruber(Markdownの作成者)およびオンライン マークダウンチュートリアル 。 Markdownで記事を書いたら、構文をHTMLに解析するためのアプリが必要になります。いくつかの素晴らしいものがあります 自由 含む: 一部の主要なプラットフォームでは、Markdownを使用したい人のために、エディターでMarkdownの使用をすでに採用しています(または少なくとも許可しています)。 WordPress、Evernote、Google Docsなどの他の製品では、ネイティブサポート(この記事の執筆時点)はまだ組み込まれていませんが、カスタムソリューションがサードパーティによって導入されています。これらには以下が含まれます: もちろん、非常に単純なため、制限があります。すでに説明したように、Markdownは、高度なフォーマット機能を必要とする複雑なワードプロセッシングタスク用に作成されたものではありません。それが必要な場合、Markdownは適切なツールではありません。 しかし、ユーザーマニュアル、技術文書、またはテクニカルレポートを作成する必要がある開発者にとって、Markdownは、シンプルさと必要な機能のほぼ完璧なバランスを提供します。 おそらく最大の欠点は、特に変更管理の専門家である私たちのエンジニアにとって、 共同作業 Markdownで変更を追跡するために(ただし、これに対する1つの注目すべき例外は StackEdit Googleドキュメントのプラグイン)。そしてもちろん、最小限の労力で、gitリポジトリを介してMarkdownドキュメントで共同作業するだけで、通常必要なすべての変更の追跡と共同作業を行うことができます。 では、Markdownをみんなのために学んでいるのでしょうか?もちろん違います。これまでに1つのツールはありません。 しかし、あなたがソフトウェアエンジニアであれば、それはまさにあなたが探していたライティングツールである可能性があります。したがって、まだ試していない場合は、実際に試してみる必要があります。# Section Heading
ではなく
# Initiating Plugins pluginName
)。次のようにjQueryを使用してコンテナで `pluginName`を開始します。
$(function() { $('#container').pluginName(); }); `$(function(){$( '#container')。pluginName();});` pluginName
を開始できます。 jQueryメソッドを使用.pluginName()
*コンテナのIDを使用して、jQueryメソッド `.pluginName()`で `pluginName`を開始できます。* マークダウンパーサーとツール
Webデザインの視覚的階層
欠点
結論