大学のプログラムの授業のレポートなどでソースコードを記載しなければならない時がありますよね。
そんな時WordやGoogleドキュメントで書くとただの文字列を書いているだけになってしまいます。
アドインできれいに書くことも出来つようですが、キーボードだけできれいなレポートを書ける「HackMD」というものを紹介します!
HackMDで書いた文章をPDFにして、きれいなレポートを作成しましょう!
今回は以前作成したこちらの指スマプログラムを用いて、解説していきます。
HackMDとは
HackMDとは、WEB上に手軽にメモを残せるサービスです。マークダウン記法と呼ばれる方法で文章を記述していきます。 ちなみにこの記事もマークダウン記法を使って書いています
まず完成形がこちらになります。
HackMDの使い方
まずはhttps://hackmd.io/にアクセスして、アカウントの登録を行います。
アカウントの登録が終わったら左側のNewNoteをクリックして、さっそく作成していきましょう!
注意点としては、右上のPublishedからReadとWriteをOwnersに変更しないと、世界中に公開されてしまうので、公開されて困る内容(レポートなど)の時は注意しましょう
それからHackMDに載せる画像は自動的にimgurという画像共有サービスに公開されるので、公開されて困るようなパスワードやシリアル番号などが書いてある画像は載せないようにしましょう!
書き終わったら、Menu > Download > HTML でダウンロードします。
ダウンロード後、Chromeで開き 右クリック > 印刷 から送信先を PDFに保存 を選択し、保存します。
マークダウン記法
今回使ったマークダウンについて解説します。
まずはこのページの解説です。
まず題名は1番上の行に# で記述します
# C言語で指スマゲームをつくる #のあとは半角スペースをつけてください!
見出しをつくるには## で記述
## 目的 こちらも## のあとには半角スペースを!
太字にするには
**太字**
リンクをつけるには
[こちらの記事](https://hacknote.jp/archives/54586)
PDFに出力した場合はこのように表示されます
箇条書きで番号をつけたい場合は
1. printf関数 2. scanf関数 3. 四則演算 4. 変数 5. if文,if~else文 6. while文 7. rand関数 半角で数字カンマを入力したあとは、半角スペースを入力してください。 Enterを押して改行した場合、自動的に次の番号が振られます。
tabを押すことでインデントをつけられます。
1. 自分と相手で両親指を出す 2. 先行は自分とする 3. 「**指スマ…**」の掛け声の後に全体の指が何本上がるかを予想して、宣言する 4. 3での宣言と同時に、自分が指を何本上げるかを決める 5. 自分が宣言した数と、全体の数を確認する 1. もし同じであれば、自分の手を1つ下げる 2. 違うなら、なにもせず相手のターンへ移行
次のページです。
文章の途中でソースコードを入力したい場合
`yubisuma.c`
ソースコードを載せる場合は
上下は一行改行しましょう
このままだと色が単一で読みづらいので、言語を指定して色をつけることが出来ます。
言語の後に「=」をつけると1から順の行番号、「=42」などのようにやると指定した番号からの行番号を指定することが出来ます。
箇条書きで・をつけたい場合
- MacOS Mojave バージョン10.14.6
- テキストエディタ: Atom
- コンパイラ:gcc
* MacOS Mojave バージョン10.14.6 * テキストエディタ: Atom * コンパイラ:gcc * の後には半角スペースをいれる
画像のように中央寄せしたい場合
マークダウンに中央寄せするものはないので、HTMLで記述して書き換えます。そう、マークダウンではHTMLがつかえます!ということは色を変えたりとかもできますね。
<div style="text-align: center;"> ここに中央寄せしたい文字を入力 </div>
最後に
このようにマークダウン記法を使って書くと、きれいに書くことができます。
私個人的にはマークダウンを使うメリットは、ソースコードがきれいに表示でき、見やすく記述することが出来る点だと思います。
HackMDだけではく、qiitaやSlackなどもマークダウン記法に対応しているので、マークダウン記法を覚えておくと様々なメリットがあります。