markdown

Every decent writer has to have a great tool.  My tool of choice has long been the Mac-based Markdown editor Mou. Created as a spare-time project by a developer named Chen Luo, the editor is now the target of an IndieGoGo campaign, which you can donate to over here.

Mou makes writing such a pleasure, and I’ve written thousands of articles on it over the years. But it’s long been running on donations, only. A crowdfunding campaign could truly push it over the edge as it aims for more features. Consider this an endorsement of an amazing tool. — Ernie @ SFB

a public list of R freelancers

tl,dr: If you want to be contacted for freelance R work, edit this list https://github.com/isomorphisms/hire-an-r-programmer/blob/gh-pages/README.md.

 

Background/Problem: I was looking for a list of R-programming freelancers and realised there is no such list.

Other than famous people and people I already talk to, I don’t know even a small fraction of the R community—let alone people who do R among other things and don’t participate in the mailing lists or chatrooms I do.

This is actually a more general problem since anyone looking to hire an R programmer will find a wall of tutorials if they http://google.com/search?q=hire+an+r+programmer.

 

Solution: I thought about making a publicly-editable website where freelancers can put their contact info, specialty areas, links to projects, preferred kind of work, rates, and so on.

Of course, I’d have to make the login system. And validate users. And fight spam. And think up some database models, change the fields if someone suggests something better…. And it would be nice to link to StackOverflow, Github, CRAN, and …

The more I thought about it the more I favoured a solution where someone else does all the work. GitHub already has a validation system, usernames, logins, and a publicly editable “wiki”. MVP. No maintenance, no vetting, no development. GitHub already shows up in google so whoever searches for “hire an R programmer” will find you if you put your details there.

It’s actually unbelievable that we’ve had R-Bloggers as a gathering place for so long, but nowhere central to list who’s looking for work.

So I committed https://github.com/isomorphisms/hire-an-r-programmer/blob/gh-pages/README.md which is a markdown file you can add your information to, if you want to be found by recruiters who are looking for R programmers. Forking is a good design pattern for this purpose as well. Add whatever information you want, and if you think I’m missing some fields you can add those as well. Suggestions/comments also welcome below.

Scriptogram: A highly-visual blogging platform for writing nerds

Cool blogging platform alternative of the day: If you’re looking with something with a little more heft that hits halfway between WordPress and Tumblr, Scriptogram, a Markdown-based blogging platform that integrates with Dropbox, might be your ticket. The theming system will feel at home if you’re a heavy Tumblr customizer, and there’s a level of control here that you may not get with a standard blog post. (There isn’t a rich-text option for writing, though Markdown is a cinch to learn.) And for SEO-focused types, it’s a little better on that front than Tumblr is. If you’re looking for a blog platform that feels like it was built out in 2012, but keeps the blogger in control of their work, this is a good bet. (Editor’s note: I’ve been playing with this all afternoon. It’s fun! — Ernie @ SFB)

2
Theme Spotlight | Readymade Lite and Lytton Lite for Ghost

Our fleet of Ghost themes continues to expand with the release of Readymade Lite and Lytton Lite. These themes share roots with their Tumblr forebears, offering similarly polished aesthetics, intuitive organization, and attention to detail.

Lytton Lite’s bold header and single-channel layout deliver unmistakeable visual spirit. Go ahead, post your photo series of chain link fences and see how wonderful Lytton Lite makes them look. Brand yourself with a custom header and logo. Be a minimalist and opt for a sleek navy background. Or express your fun side with a .GIF header image.

Readymade Lite also sports a robust single-channel display. Give your bio and contact information a place of its own by taking advantage of the “About” page’s crisp overlay design. Tuck your navigation into the thoughtfully organized sidebar, and draw attention to your sure-to-be striking header image.

Like our other Ghost themes, Readymade Lite and Lytton Lite use Markdown language, promising a simple and pleasurable blogging experience. A slew of Markdown quick codes makes any formatting truly easy.

Check out Readymade Lite’s demo here and Lytton Lite’s demo here. Pick them up for $25 each.

【チュートリアル】「Markdown記法」入門 ~ シンプルな記法でサクサクHTMLを書くことで、メモ力や文章共有力の向上を

以前から何度も言っているようい、こんどIPython notebook について紹介する予定なのですが、まずはそのための準備として、IPython notebook で使う事になる「Markdown」のチュートリアルをこの記事では書きました。

本ブログの4月まで対象としてたコンピュータビジョン関連の専門性の高い読者の皆様は、Markdownを普段使っていない方が多いかと思ったのがMarkdownのチュートリアルを書いた理由なのですが、科学技術者向けのMarkdown記法というものはあり無かったと思うので、研究開発する上でのMarkdown利用の利点もあとで述べていきます。

また、今年4月のDERiVEのリニューアルは、一般的なIT開発者の皆様もたくさんこのブログの読者になってくれると嬉しいと思っているので、その呼び込みの意味でも(Web開発界隈だとMarkdown以前から使っている方も多いと思うのですが)あらためて私の視点からMarkdownを紹介します(もちろん、この続きとして今度公開するIPython notebookの記事も、ITエンジニアならどなたにでも役に立つ記事となるはずです)

私もWeb界隈の人間でないためMarkdownまわりは必ずしも全ての事情に詳しいわけではないので、お手柔らかにお願いします。

Markdownとは?

Markdown(記法)は軽量のマークアップ言語で、HTMLやLatexのように、構造的な文書生成のためのものですが、旧来のように極端に記法がシンプルであるおかげで、その活用範囲がどんどん広まっているものです。

特徴としては:

  • HTML相当の構造的な文書を、非常に簡略化された表記でサクサク書ける
  • (文章だけブログやWikiにアップする場合などでは)HTMLを書かなくてMarkdownで簡単に済ませられる
  • 構造化された綺麗なプレインテキストをWYSIWYGエディタなどでのGUI操作無しに、キーボード操作だけで作れる
  • 主要なWebベースのサイトやシステムが。HTML作成の記法としてMarkdownを採用している(GithubやWordpress、IPython notebook Viewerなど)
  • (追記)R markdown やipython notebookなどrepoducibleな研究ノートを作成するための、構造化テキスト作成を支えている。(R に関しては「~knitr+pandocではじめる~『R MarkdownでReproducible Research』」などを参照)

などが考えられる主要なものです。私のように30歳を超えたエンジニアですとpukiWikiなどのwiki記法などが思いつくかもしれませんが、ああいったWeb向けのシンプルな記法のうちの一番人気のものでです。

Markdownは、超有名なApple系の情報ブログである「Daring Fireball」の著者であるJohn Gruberが初めに開発を始めたもので、読みやすくてサクサク書けるプレーンテキストを、XHTMLにすぐ変換ができる(すなわちブラウザ上でHTMLにすぐ変換される)ためのマークアップ言語として、作られたものです。以下,Gruber氏によるMarkdown公式サイトです

http://daringfireball.net/projects/markdown/

WordpressやMovable Typeなどを使っている方々はご存知のとおり、これらのWeblogサービスではMarkdownでも記事が書けるようになっていたりします。もちろんこれらのWebでHTMLを編集できるサービスではWYSIWYGなエディターが搭載されているのが普通ですが、Markdown記法はそれこそあなたの好きなエディタでタイプしてファイルで保存していてもOKとなります。後で紹介しますが、Markdown対応のエディタではHTMLにコンパイルしたものもすぐに確認できるので、ローカルで編集したMarkdown記法の文書を、最後にWordpressにコピペするだけですぐHTMLとして記事を公開できるわけです。

それではここからは

  • Markdown記法の実際の文法を紹介
  • Markdown対応のエディタやソフトウェア
  • Markdownの活用のヒント

という流れで書いていきます。

Markdown記法 

以下、Wikipedia:Markdownからの引用ですが、今から紹介する記法のデザインが電子メールの装飾から出たアイデアなのかについて書かれています:

Markdown の記法の多くは、電子メールにおいてプレーンテキストを装飾する際の慣習から着想を得ている。

考案者のGruber氏のMarkdownのページ「Markdown Syntax Documentationに、各syntaxが説明されています。

日本語のwikipediaには各シンタックスが解説されていますhttp://ja.wikipedia.org/wiki/Markdown

現在では以下のgithubに公開されているMarkdown Cheat sheetをブックマークするのが一番良いリファレンスになると思います。

Markdown Cheat sheet

https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

このようにMarkdownについては、Web上にたくさんの解説があるので、私の方からは簡単にだけ代表的な記法を紹介します。以下のMowというMarkdownエディタで私が書いた、Markdown文書の例の画像をごらんください 

image

Mowでは左側にMarkdownを書く事ができ、編集しているとそれが(X)HTMLとして生成された結果がリアルタイムに右側にレンダリングされます。これを眺めながら、以下の各記号の意味の解説を読んでみてください。

見出し記号: #

記号「#」はHTMLでいう 「<h1> <h2> <h3>」らの見出しタグに相当します。 #の数がそのまま 見出しの階層を示し、#のあとにスペース(空白)を挿入するだけで、タグでは囲わないでも(この「記号のあとに空白を置く事が、HTMLでのタグ囲いに相当する」という文法は、各記号に共通する内容なので重要です)。

リスト記号:* , - , +

記号「*」「-」「+」のいずれかを用いるとリスト構造を作れます

段落分け:単に改行するだけ

HTMLでは<p>で囲んだ塊が1つの段落になりますが、Markdownは改行するだけでそれぞれが1つの段落としてみなされます

強調:記号「**(太文字にしたい単語)**」と「**」で両脇を囲う

<b>タグに相当する操作です。太字にしたい単語の両脇を囲います(空白は使いません)

URLリンク:[言葉](URL)

HTMLを文章で書こうとすると頻度が多い割にすぐタイピングできなくて一番めんどくさいのがこのリンク作成のための<a href=”URL”> </a>とうHTMLのタグだと思いますが、Markdownはこのように角カッコと丸カッコで済みます。Latexのように最後にラベル番号づけしたURL対応リストをかいておいて、そのラベルだけをURLの参照に用いることもできます。以下、公式サイトのSyntaxから解説を引用しておきます

You can optionally use a space to separate the sets of brackets:

This is [an example] [id] reference-style link.

Then, anywhere in the document, you define your link label like this, on a line by itself:

[id]: http://example.com/  "Optional Title Here"
Markdownが使えるエディター

Markdown記法で書ける代表的なエディタには例えば以下のようなものがあります

Mou (Mac OSX)

nvALT (Mac OSX) (※ 私のメインのメモ作成ソフトです。今度メルマガの方でこのアプリの解説を書きます)

Kobito :Qiitaユーザーは連携機能に注目

Haroopad(win/mac/linux):解説記事

Markdown#Editor (win)

また、インストール型ではないですが、Markdown記法に対応しているWebサービスが色々あります(ここは私は詳しくないので割愛)

GithubやQiitaは独自の拡張Markdown記法も導入されていたりして、サイトの目的ごとにMarkdownが拡張されているものもあります。

紹介したエディター以外でも、Markdownが拡張的にサポートされているようなサービスやソフトウェアは色々あるので、各自自分の使っているソフトウェアやサービスがMarkdown活用できるかについては調べてみてください。

Markdownの活用

最後にMarkdownの活用について少しだけ議論しておきます。

汎用的な文書作成なので、活用目的は色々と考えられます。まず、議事録でMarkdownにしようという記事を紹介します;

メモはテキストエディタだけで良い!これからはMarkdownでメモをとろう!~議事録からちょっとしたアイデアまで~

この記事でも書かれていますが、HTMLのタグ囲いに対して、「MarkdownはHTML化する以前のソースが既に見やすい構造である」という利点は大きいと思います。

また、以下の記事では、「MS wordはやめて、Markdownにしませんか」という主張をしている、興味深いコラムです。

smart blog:markdown記法の普及とMS wordへの執着

一方、以前からのこのブログの読者層の中心であった、科学技術計算が行えるレベルの皆様は、Mathmatica NotebookでのMarkdownやIPython notebookのMarkdown Cell(scipy2013のチュートリアル)でもMarkdownで文書を書く事ができます。IPython notebookでは、ノート付きのpythonプログラムを作成して、それをチームのみんなやWebに共有できるわけですが、Markdownでサクサク綺麗な構造化された文書を書く事ができます。

普段のノートがプレインテキストである人に対して、Markdownで見出しやリスト付けが綺麗行う文書を使うようにすると、チーム内でのドキュメント共有の質や、個人でのアイデアの蓄積や整理の質も上がるはずです。仕事のレベルが向上してくると思います。もちろんWikiサーバなどを用いてそこにグループでの文章を共有しているということでも、見えとしては整形されたHTMLで同じなので、同じ効果が生まれるでしょう。ただい、MarkdownはHTMLや他のwiki記法に比べて、ソースの文書そのものも見やすくて美しくなるので、Markdownを使うとその恩恵は受けると思います。(もちろんプレインなテキストのみでも十分にできることは多いので、Markdownを使えばなんでもいいというわけではありません。電子メールも多くはプレインテキストなわけですし)。

繰り返しですが、WISYWIGエディターを介さずに、キーボード操作だけでスラスラと「構造化文書」を書ける事は、どんなひとでも大きな利点であり、Markdownは身につけておく方がよいです。(とはいえ身につけておくというハードルの高さがないようにデザインされたのがMarkdownの良さでもあります)。

(以降、追記)

冒頭の特徴の1つである「Reproduceble Reserach 」を行うための、ノートとスクリプト実行環境が一体型になっている各種ソフトウェアにおいて、Markdownは生かされているというのも、科学技術計算系のみなさまにはMarkdownが書けるのはメリットです。本ブログでは、まだ日本語の情報が少ないのもあり、IPython notebookに焦点をあてますが、R Studio向けのknitrMathematicaノートブックなど、markdownはこれらのインタラクティブノートブック全般で役にたつものです。

ここまでメリットばかり述べてきましたが、一方でMarkdownではHTMLで言う「Table」が作れないなどフルスタックなものではなく、必ずしもHTMLと同等のフルスタックな記法ではありません。(なので、例えばGithubのMarkdownなどでは独自のTable記法が独自に追加されている)

記事公開後にTwitterでの反応で、Markdownはフルスタックではないという理由で、ReSt(ReStructuredText)の方がよいと薦めているかたもいました。

まとめ

以上、科学技術系よりが現在のところは読者の中心である本ブログが、そういった読者の皆様はあまり触れていないかもしれない「Markdown」について、入門を書きました。HTML相当の構造化された文章(この記事のような)をスラスラと書けるMarkdownは、みなさんのデジタルノートの質(と量)を大きく改善するはずですので、Markdownの存在を知らなかった方は是非ためしに使ってみてください。

本記事が参考になったという方はDERiVEメルマガの応援や、関連する記事の共有もしていただけると幸いです(メルマガでも2014年4月以降、IT開発者一般向けの役立つ情報も発信していますので、「専門性は私は高くないんだけど。。」という方も、最初の一ヶ月は購読無料ですので一度おためしください)。

また、2014年4月のリニューアル以降書くようにしはじめた「IT開発者向け全般が対象の記事」は、「#開発者全般向け」でタグ付けしてあるので、そちら目当ての方も、よろしければ本ブログを継続的にチェックしてみてください。

More on Ghost and blogging platforms

itsagreatbigbeautifultomorrow said: Ghost looks really cool. In the opening video, I swear though, it said it is free and will try to remain free. But I signed up and then it told me how much it cost to have blogs. Did I miss something?

» SFB says: Ghost is open-source, meaning it’s free as in speech, meaning you can download the software and do what you want with it—as long as you have a host. (A host is something, BTW, that Ghost offers for a modest monthly fee.) Tumblr is free as in beer, which means you can use it, but you don’t own the platform and have no control over it. Ghost is a more modern platform, though the distribution model is closer to WordPress than Tumblr. — Ernie @ SFB

WordPressでMarkdown使えるようになった

Jetpack で遂に Markdown がサポートされた。これで WordPress でも Markdown が使えるようになる。

http://jetpack.me/support/markdown/

WordPress、wordpress.org と wordpress.com の2種類あって、前者は自分でサーバーにインストールするタイプ、後者はインストールしなくてもユーザー登録すれば普通に使えるタイプ(いわゆるレンタルブログです)。

Jetpack っていうのは、wordpress.com で先行実装されてる機能を WordPress で使用できるプラグイン。

今まで

今まで WordPress で Markdown 使うには、サードパーティ製プラグインを使う必要があった。ぼくは Markdown on Save Improved 使ってた。

最近管理画面で「もうこのプラグインは開発終了したから今後は Jetpack 使ってね」的なメッセージが出るようになって、移行を推奨された。移行は特に難しくなく、手順に従ったらできた。

なんかpタグがおかしい

Markdown on Save Improved を無効化して、 Jetpack で Markdown を有効にしたのだが、pタグだけが記事に反映されない。(そのせいで今日の午前中は http://www.sanographix.net/ の記事がぐちゃぐちゃになってた。)

解決

なんかプラグインが悪さをしているはずだと思ったら、やっぱりそうで、 PS Disable Auto Formatting を無効にしたら解決した。エディタの自動整形を無効にするプラグイン。

Markdown最高

ぼくは WordPress 以外にも、Tumblrや、メール、適当なメモ書きに至るまで、ほとんどの文章を Markdown で書いている。Markdownは、読みやすく書きやすい体裁になるうえ、覚えるのが簡単で、メリットばかりある。だからブログ等のウェブサービスを選ぶときは、Markdown をサポートしているかどうかが重要になってくる。記事は大切な資産なのでなるべくサードパーティ製プラグインではなく公式にサポートしてほしいと思っていたが、Jetpack で半公式的にサポートしてくれたことにより念願叶ってという感じになった。

Markdown にご興味のある方は下記の記事も参考にしてください。

Mou - Markdown editor for developers

When current available Markdown editors are almost all for general writers, Mou is different: It’s for web developers.Syntax highlighting, live preview, fullscreen mode, auto save, powerful actions, auto pair, incremental search, custom themes, HTML export, enhanced CJK characters support. I know, it’s exactly the app you want.

image

Download it here: http://mouapp.com/

The best Markdown editor, hands-down

kohenari said: Love the use of Markdown and the immediate preview.

» SFB says: If you do, I very highly recommend the OSX text editor Mou, which I use to write everything that doesn’t show up on Tumblr. I’ve tried a lot of things, and it’s the best thing going if you like Markdown. A big reason for that is that so few of its competitors get the keyboard command aspect of the equation down. Ghost’s frickin’ awesome editor, which is pretty solid, was directly inspired by Mou. — Ernie @ SFB