脱Word、脱Markdown、asciidocでドキュメント作成する際のアレコレ - Qiita
asciidocとは asciidocはMarkdownなどのような軽量マークアップ言語の一つで、Webページなどをプレーンテキストで記述することができる(拡張子は.adoc) asciidocを使うようになった経緯 これまではWordで機能仕様書とか書いていたが、Wordは重い、変更場所が分からない、複数人同時に修正とか面倒で、いい加減Wordを使うのは止めたくなった なので軽量マークアップ言語にしよう、一番メジャー？なMarkdownにしたら、以下の制約とかでいくらなんでもイマイチ。。 表でセルの結合ができない 表のセル内で箇条書きができない 目次が作れない 文字に色がつけられない 上記に対応しようとすると、プラグインやらMarkdown亜種がいろいろ。。 そこで、Markdownより表現方法が豊富なasciidocを使用し、実際に使って、特徴・課題を挙げてみた。 asciidocto
AsciiDocを全力で勧める 4つの理
AsciiDoc は Markdown と同じ軽量マークアップ言語の一種です。仕様書などの文書を書く上ではMarkdownより利点・メリットがあると感じていて、もともと Markdown で仕様書などを書いていましたが、今は AsciiDoc へ移行しました。 今では、 メモ、README など簡単なテキスト、ブログ記事書き => Markdown 仕様書などある程度分量のある文書 => AsciiDoc というすみ分けをしています。 Markdown と AsciiDoc を使ってみてわかった、AsciiDoc の良いところを 4つ記載します。 仕様が明確 AsciiDoc は仕様が明確です。どういう表現があるのか、どういう書き方をすれば良いか、公式のユーザガイドを見れば全て記載があります。 Markdown は方言が多いため、一言で Markdown 対応のツールと言っても対応している
AsciiDocで目次を自動作成する(ToC) - やってみる
なんと、見出しから目次を自動で作ってくれる。 成果物 AsciiDoctor.Hello.ToC.201705101305 開発環境 LinuxMint 17.3 MATE 32bit rbenv Ruby 2.4.0 AsciiDoctor Firefox AsciiDoc ビューア pluma AsciiDoc ハイライト 前回まで http://ytyaru.hatenablog.com/entry/2018/02/02/000000 http://ytyaru.hatenablog.com/entry/2018/02/03/000000 http://ytyaru.hatenablog.com/entry/2018/02/04/000000 http://ytyaru.hatenablog.com/entry/2018/02/05/000000 参考 http://asciidoc
技術書典5で頒布する予定の本のコードの動作チェックや、文章の校正をCIでするようにした話
TL;DR (概要) Crystalのような破壊的変更がアクティブなプログラミング言語の本を作る場合、バージョンアップで本の内容が壊れることが よくある。 この問題に対処するため、技術書典5で頒布する予定の本では、サンプルコードが正しく動作することをCIで確認するようにした。 ソースコードのフォーマット忘れが無いかもチェックするようにした。 ↑のようなことができたのはAsciidoctorのソースコードをincludeする機能の力が大きい。 ついでにRedPenで文章の校正も行なうようにした。 長期間に渡ってメンテナンスする予定の本であればこのような工夫するのは当然だし、そうでなくても本の品質を高める意味でこの工夫には価値があると思う。 はじめに(ポエム) Crystal-JPというプログラミング言語Crystalの日本語ユーザーグループで、Crystalの普及に勤しんでいる、ということに
asciidoctor-pdfで複数行のフッタを作る
会社のWordテンプレのフッターが複数行なので、asciidoctor-pdfで複数行のフッタを出力する方法を調べました。 テーマファイルの書き方 今回は、PDFのフッタにページ番号とコピーライトをつけます。その場合、テーマファイルを以下のように記載します。参考：Running header & footer footer: font_size: $base_font_size_small font_color: $base_font_color border_color: dddddd border_width: 0.25 height: 25mm padding: [3mm,0,0,0] vertical_align: top recto_content: center: | {page-number} / {page-count} + Copyright © hogehog
AsciiDoc と PlantUML と mermaid.js で素敵なテキストベース仕様書ライフ
以前からテキストベースで仕様書(PDF)などを管理したいと思っていたのですが、ようやくその環境が整い、一度実際に運用してみてかなりいい感じだったので紹介したいと思います。 基本テキストは AsciiDoc で記述する UML は PlantUML で記述する フローチャートとかは必要に応じて mermaid.js も使う つまり基本テキストで表現・管理できるものはテキストで書く 成果物は PDF形式。目次(Table of Contents) はつける。 動作確認環境 macOS Sierra 10.12.3 ruby 2.3.1 Asciidoctor 1.5.5 Asciidoctor PDF 1.5.0.alpha.14 Asciidoctor Diagram 1.5.4 mermaid 7.0.0 AsciiDoc とは AsciiDoc Home Page 軽量マークアップ言語の
AsciiDoc と PlantUML (仮) - Qiita
GitLab CE が AsciiDoc ドキュメントへの PlantUML埋め込み に対応しました。また、AsciiDoc JebBrains Plugin を使えば、IntelliJ Idea で AsciiDoc をプレビューすることができます。(しかも、PlantUML に対応しています) 今まで難しかった設計書の管理を GitLab CE/EE でできそうな気がしてきました。まだどこかの開発で使ったという話ではありませんが、調べてみた結果を掲載します。また、マニュアルを書くのにもとても役に立ちそうです。 はじめに AsciiDoc とは? AsciiDoc は公式サイトでこのように書かれています。記事やドキュメントや書籍などを書くためのフォーマットで、HTMLやPDFやEPUBなどに出力できます。 AsciiDoc is a text document format for wr
CDK - Twitter製。AsciiDocをHTMLスライドに変換 MOONGIFT
最近はプレゼンテーションのスライドもHTMLで作ることが増えてきました。余計なエフェクトや装飾を気にせず内容だけに集中できますし、コンテンツを公開すればWebクローラーフレンドリーです。 幾つかのツールがありますが、今回はTwitter社の開発したCDK（Courseware Development Kit）を紹介します。AsciiDoc記法で作るHTMLスライドツールです。 CDKの使い方 CDKのインストールはpipで行います。 pip install cdk そしてAsciiDocを引数に渡します。 cdk sample.asc そうするとHTMLファイルが生成されますので、それを開くだけです。 こんな感じに中央に大きな文字が特徴です。 日本語も使えます。コードはちょっとカードっぽく表示されます。 コマンドヘルプです。 スライド一覧。 アウトライン。 スライドジャンプも。 Ascii
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
[支える技術]エクセルやパワーポイントのドキュメントを捨てて、超美麗なドキュメント作成をasciidoctorで実現しよう！![[支える技術]エクセルやパワーポイントのドキュメントを捨てて、超美麗なドキュメント作成をasciidoctorで実現しよう！](https://cdn-ak-scissors.b.st-hatena.com/image/square/e45f65486901307445fa766ae58c9833f354eda9/height=288;version=1;width=512/https%3A%2F%2Fprice-checker.jp%2Fwp-content%2Fuploads%2F2015%2F01%2Fpicjumbo.com_HNCK4034.jpg)
Redirect Notice