Markdownとは
Markdown は、文書を記述するための軽量マークアップ言語のひとつです。「書きやすくて読みやすいプレーンテキストとして記述した文書を、妥当なXHTML(もしくはHTML)文書へと変換できるフォーマット」として、ジョン・グル―バー(John Gruber)とアーロン・スワーツ(Aaron Swartz)によって考案されました。Markdownの記法の多くは、電子メールにおいてプレーンテキストを装飾する際の慣習から着想を得ています。(こちらより引用)Markdownでコードを記述する場合
Markdownでコードを記述する場合、コード部分にバッククオートを3つ続けるとソースコードのハイライト表示ができます。このときに、先頭のバッククオートのあとに言語名を記述すると、言語ごとの文法を考慮したハイライトが表示されます。
例 Rubyのコードでハイライト表示する
バッククオート3つでくくり、rubyを指定します。
```ruby
# Sample code.
require 'active_support'
class Qatmarkit < Atmarkit::Base
def hello
@hello ||= "hello"
end
end
```
表示は以下のようになります。
# Sample code. require 'active_support' class Qatmarkit < Atmarkit::Base def hello @hello ||= "hello" end end
0 件のコメント:
コメントを投稿