本来なら「Vagrant で Docker コンテナ立ち上げて Ansible でプロビジョニングして開発環境を用意しよう！」のその3を書くところですが。 今回は脱線して軽量マークアップ言語 AsciiDoc について普及したいと思います！ 結論から言うと こんな感じに書けるよ！ AWSによるクラウド入門 Markdown よりも表現力が豊かだよ！ Git 並に覚えるのは大変だよ！ 軽量マークアップ言語とは？ Wikipedia によると、軽量マークアップ言語とは次の通り。 軽量マークアップ言語（けいりょうマークアップげんご、英語: lightweight markup language）は、人間がシンプルなテキストエディタを使っての入力が容易になるように設計された、簡潔な文法をもつマークアップ言語である。 引用：『フリー百科事典 ウィキペディア日本語版』より。 エンジニア界隈で有名どころ
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? Intro こちらの技術書を執筆しました。15Stepで踏破 自然言語処理アプリケーション開発入門 本稿は書籍そのものの紹介ではなく、私が技術書を執筆するために利用した技術・用意した環境についての解説です。 私が執筆を始めた当時（2017年下旬）はWebを漁ってもあまり技術書執筆のノウハウがなく、本稿の内容も割と手探りでした。今ググってみると技術書展のおかげで大量に情報が出てきますね。それらと被る部分もありそうですが、自分が１冊書いてみて得たノウハウみたいなものをここに吐き出してみたいと思います。 執筆フォーマットの決定 まずは執筆に使
技術書、ブログ、READMEを書いてていて、文章中に出てくるコードブロックのコードをテストしたいことがあると思います。 そのサンプルコードが本当に動いてるのか不安になることがあるからです。 power-doctestは、そのコードブロック中のコードにコメントを入れるだけでテスト可能にするツール群です。 power-doctestの例 具体的な例から見ていきます。 次の例では、Markdownで説明とJavaScriptのコードブロックを書いています。 デフォルト引数を使って書くことで、このような挙動は起きなくなるため安全です。 デフォルト引数では、引数が渡されなかった場合のみデフォルト値が入ります。 ```js function addPrefix(text, prefix = "デフォルト:") { return prefix + text; } // falsyな値を渡してもデフォルト
「ゼロからわかる Ruby🔰超入門」という本を書きました。共同執筆での作業を効率的に進められるように、編集者・レビュワーさんを含め、みんながいつでも最新の原稿を確認できるように環境を整えました。ここでは、技術面・環境面で工夫したこと、得た知見を共有します。書籍に限らず、技術文書の作成にも使えます。 はじめに この本は、 @igaiga さんと共同で執筆しました。イラストを描いてくれた @becolomochi さんを含めて、3人での共同作業でした。原稿を書いてから公開するまでのフローはこんな感じです。プログラミングでの開発に似ています。 原稿を書く (Asciidoc, Atom, Visual Studio Code) 共有する (GitHub, Slack) HTML/PDF形式に変換する (Rakefile, CircleCI) 限定公開する (docker, nginx) Ste
Markdownが開発者界隈でのマークアップ記法として有名になっていますが、記法自体はそれ以外にも多数存在します。その一つがAsciidocです。Markdownよりも多彩な記法が用意されており、より細かく制御できます。 そんなAsciidocを記述するためのエディタがAsciidocFXです。さらに多くのフォーマットに変換できます。 AsciidocFXの使い方 メイン画面です。左からファイルツリー、エディタ、プレビューとなっています。 メイン画面 テーブルなどはダイアログで指定可能です。 テーブル追加 日本語も使えます。テーブルはヘッダーもあって、若干機能が多いです。 テーブル追加後 左側はアウトラインにも変えられます。 アウトライン表示 AsciidocFXを使えばAsciidocで使える記法がそのまま指定できるでしょう。書き方に慣れていない人であってもすぐにAsciidocが使える
AsciiDoc は Markdown と同じ軽量マークアップ言語の一種です。仕様書などの文書を書く上ではMarkdownより利点・メリットがあると感じていて、もともと Markdown で仕様書などを書いていましたが、今は AsciiDoc へ移行しました。 今では、 メモ、README など簡単なテキスト、ブログ記事書き => Markdown 仕様書などある程度分量のある文書 => AsciiDoc というすみ分けをしています。 Markdown と AsciiDoc を使ってみてわかった、AsciiDoc の良いところを 4つ記載します。 仕様が明確 AsciiDoc は仕様が明確です。どういう表現があるのか、どういう書き方をすれば良いか、公式のユーザガイドを見れば全て記載があります。 Markdown は方言が多いため、一言で Markdown 対応のツールと言っても対応している
asciidocとは asciidocはMarkdownなどのような軽量マークアップ言語の一つで、Webページなどをプレーンテキストで記述することができる(拡張子は.adoc) asciidocを使うようになった経緯 これまではWordで機能仕様書とか書いていたが、Wordは重い、変更場所が分からない、複数人同時に修正とか面倒で、いい加減Wordを使うのは止めたくなった なので軽量マークアップ言語にしよう、一番メジャー？なMarkdownにしたら、以下の制約とかでいくらなんでもイマイチ。。 表でセルの結合ができない 表のセル内で箇条書きができない 目次が作れない 文字に色がつけられない 上記に対応しようとすると、プラグインやらMarkdown亜種がいろいろ。。 そこで、Markdownより表現方法が豊富なasciidocを使用し、実際に使って、特徴・課題を挙げてみた。 asciidocto
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く