こんにちは、エンジニアの宇佐見です。 私の普段の仕事では、多くの時間をソフトウェアの設計やコードの読み書きで過ごしています。しかし、ときには仕様書や報告書のように体裁が整った文書をつくる場合もあります。私はそういった文書を書くときにも、コードを書くときと同じように、プレーンテキストで書くことが多いです。 プレーンテキストで体裁が整った文書を書くときに便利なのが、軽量マークアップ言語のひとつである AsciiDoc です。軽量マークアップ言語といえば Markdown がよく知られていますが、ここで挙げた AsciiDoc は、表形式、画像の配置指定、目次の出力、などの体裁を整える際に便利な記法がサポートされているのが特徴です。また、Asciidoctor による拡張で、各種の作図記法(blockdiag、PlantUML、Graphviz など)を文書に埋め込むことも可能です。 この記事で
シナプスの技術部 システム開発課の蔵坪と申します。 弊社は、10年近くソースコードは、Subversionで管理しておりましたが、昨年、GitLabに移行しました。 弊社でお世話になっているパートナーさんから、GitLabはAsciiDocが利用できるので、仕様書などのドキュメントは、AsciiDocがお勧めだとアドバイスをもらいました。そこで、Windows上のVisual Studio CodeでAsciiDocのプレビューできる環境を構築してみました。 AsciiDocとは AsciiDocとは、メモ、ドキュメンテーション、記事、本、電子ブック、スライドショー、Webページ、マニュアルページ、ブログを書くためのテキスト文書フォーマットです。 試した環境 OS : Windows 10 Professional (1809) AsciiDocのプレビューに必要なツール Chocolat
原著バージョン: 2.18 更新日: 2022/04/29 翻訳者(アルファベット順): becolomochi makotosan niszet Takada Atsushi Tomoki Ishibashi Yuki Fujiwara 概要¶ pandoc [options] [input-file]… 説明¶ Pandocは、あるマークアップ形式から他の形式へ変換する Haskell ライブラリと、そのライブラリを用いたコマンドラインツールです。 Pandoc は、 Markdown 、 HTML 、LaTeX 、 Word docx など、これに限定されない多数のマークアップとワープロ形式の間で変換することができます。入力および出力形式の完全なリストについては、下記 (options below) の --from と --to を参照してください。 Pandoc は PDF 出力
以前からテキストベースで仕様書(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 軽量マークアップ言語の
ドキュメントツールのインストール(Windows) Macの場合の設定方法は、本項の後に記載 PowerShellの起動 各種ツールをインストールするため、PowerShellを管理者として実行 Windowsボタンを押下 powershell と入力 右クリックで管理者として実行 を選択します Chocolateyのインストール 本手順は前述で起動したPowerShellを利用 1.Chocolatey のサイトにアクセスし、インストールコマンドをクリップボードへコピー 2.前項でコピーしたコマンドをPowerShellにペーストして実行します Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServiceP
Store documentation in one or more repositories No matter how many git repositories you use, Antora can retrieve and aggregate all the content from them to assemble a documentation site. Workspaces that fit team and content requirements Since documentation files can be stored in separate repositories, the teams that maintain them can use the administration policies, version schema, and release sch
ご存じの通りこのブログは私の大好きなWordPressを使っていますが今回はちょっと変わり種の紹介。 このエントリで扱っている内容はかなり古くなっています。日本語READMEもふるくなっているため英語版のReadmeなどを参考に。といってもあまりメンテされていないようですが……(あとこの記事内の画像は複数欠落しています) HubPress、しってますか? HubPressはちょっと特殊なブログアプリです。ちなみにGithubページを利用したブログを構築できる・「HubPress.io」 – かちびと.netで存在を知りました。一ヶ月半ぐらい前ですね。 takkyuuplayer氏によるREADME-jaがあったのでそれの追加修正をさっせてもらってます。(何度もPRやissueを送ってたらコラボレーターになりました。write権限は無いけど。)(もちろんPR大歓迎なんだからねっ!) 何が特殊
asciidocとは asciidocはMarkdownなどのような軽量マークアップ言語の一つで、Webページなどをプレーンテキストで記述することができる(拡張子は.adoc) asciidocを使うようになった経緯 これまではWordで機能仕様書とか書いていたが、Wordは重い、変更場所が分からない、複数人同時に修正とか面倒で、いい加減Wordを使うのは止めたくなった なので軽量マークアップ言語にしよう、一番メジャー?なMarkdownにしたら、以下の制約とかでいくらなんでもイマイチ。。 表でセルの結合ができない 表のセル内で箇条書きができない 目次が作れない 文字に色がつけられない 上記に対応しようとすると、プラグインやらMarkdown亜種がいろいろ。。 そこで、Markdownより表現方法が豊富なasciidocを使用し、実際に使って、特徴・課題を挙げてみた。 asciidocto
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く