PlantUML はテキストファイルから UML 図（PNG や SVG ファイル）を生成することができる Java 製のツールです。ここでは、plantuml というコマンドを使用できるようにするまでの手順を示します。 Graphviz のインストールPlantUML は図の生成のために内部で Graphviz の dot コマンドを使用するので、先に Graphviz をインストールしましょう。 Graphviz - Graph Visualization Softwareここでは、上記のサイトから ZIP ファイル graphviz-2.38.zip をダウンロードし、展開してできた release ディレクトリ内のファイル群を C:\app\graphviz-2.38 というディレクトリ内に配置するとします。 Graphviz に含まれる dot コマンドのパスを環境変数 GRAP
実践UML 第3版 オブジェクト指向分析設計と反復型開発入門 作者:クレーグ・ラーマンピアソンエデュケーションAmazon 目次 目次 はじめ Markdownで書くメリット Markdown記法一覧 環境構築手順 1. Visual Studio Codeをインストールする 2. PlantUMLをインストールする 3. Javaをインストールする 4. Graphvizをインストールする 5. Markdown Preview Enhancedをインストールする 環境構築後の動作確認 Markdownでドキュメントを書く際に便利な拡張機能 1. Paste Image 2. markdown-index 作成したドキュメントをHTMLやPDFに変換する 今回参考にさせていただいた記事 はじめ 自分はこれまでソフトウェア開発において仕様書や設計書を作成する際、Enterprise Arc
はじめに CircleCIのアイコンをPlantUMLで使用したかったのですが、こちらには無かったので生成しました。 その時の備忘録です。 画像の準備 埋め込みたい画像を用意してください。 注意点として、ファイルサイズが大きい画像だとエンコードは出来ても、デコード時に失敗します。 どのくらいが限界なのか分からないのですが、今回は48x48 pxの画像を用意しました。 また、透明箇所は黒として処理されるようなので、背景が白の画像を用意してください。 グレースケールにエンコード 次に画像をグレースケールにエンコードする必要があります。 ターミナルで下記のコマンドを実行します。 $ java -jar plantuml.jar -encodesprite 16z circleci.png sprite $circleci [48x48/16z] { bLPLWiKm20nnPUz_shLN2zH
シーケンス図をテキストで描いてMarkdownに埋め込みたい README.md のような Markdown ファイルに、シーケンス図をテキストで描いて、埋め込みたいんです。 でも、たいていは「テキストでシーケンス図を描いて、それを画像にしてアップロードして、そのURLをMarkdownに記述する」という方法でした。 Markdownテキストでシーケンス図とフローチャートを描く - Qiita Markdownでシーケンス図を書いてGithubのREADME.mdに埋め込む - Qiita もっと簡単にできないものかと調べてみると、StackOverflow に git - How to integrate UML diagrams into GitLab or GitHub - Stack Overflow がありました。 PlantUML proxy service を使う方法です。
長くなるので、図の書き方はクラス図とシーケンス図だけで。 その他の図については 続・PlantUML使い方メモ #PlantUML - Qiita を参照。 PlantUML とは テキストで UML 図を記述できる DSL の一種（たぶん） 本体は Java で書かれていて、単一の jar ファイルを落としてきてコマンドラインから実行できる plantuml/plantuml: Generate UML diagram from textual description ただし、実際に使うときは Visual Studio Code とかのプラグインを入れて実行することが多いと思う ライセンスは GPL v3 plantuml/license.txt at master · plantuml/plantuml 環境構築 OS は Windows10。 Java インストール方法は割愛。 P
This post covers PlantUML basics and how it can be used in GitLab or GitHub projects as well as a seamless local development environment using Visual Studio Code. I have been wanting to write this post for months. Lately I have been using PlantUML extensively at work but also in my private projects. You can see it being used in my plantbuddy and techradar projects on GitHub. Using it in different
どうも。システムディレクションチームのいとうです。 幼少向け や 学校法人様向け などいろいろなサービスの開発側ハンドリングをしています。 さて、いろいろな要求仕様を具体的な設計に落とし込んでいったり、既存の仕様を整理するために、ユースケースやフローチャートを作成したり ER 図を書いたりすることはよくあるかと思います。 こういう図って、性格が出ますよね。 ツールによってはどうしても線が曲がってしまったり、きれいに整列させることが難しかったり、またせっかくきれいに書いていても、途中で間にオブジェクトを追加するとレイアウトが崩れたりなかなか厄介です。オンライン・オフライン問わず、ライセンスの数が足りなくなったりもありますよね。 また、最終的に出力されるのが画像なので、変更差分を目で見ると大変ですし、履歴を残すにしても人によって変更履歴の粒度はまちまちです。 そこで、PlantUML。 seq
AsciiDoc と PlantUML (仮) GitLab CE が AsciiDoc ドキュメントへの PlantUML埋め込み に対応しました。また、AsciiDoc JebBrains Plugin を使えば、IntelliJ Idea で AsciiDoc をプレビューすることができます。(しかも、PlantUML に対応しています) 今まで難しかった設計書の管理を GitLab CE/EE でできそうな気がしてきました。まだどこかの開発で使ったという話ではありませんが、調べてみた結果を掲載します。また、マニュアルを書くのにもとても役に立ちそうです。 はじめに AsciiDoc とは? AsciiDoc は公式サイトでこのように書かれています。記事やドキュメントや書籍などを書くためのフォーマットで、HTMLやPDFやEPUBなどに出力できます。 AsciiDoc is a tex
皆様初めまして、19新卒の坂井です。 AIサービス開発本部のAI Cameraチームに所属し、普段は画像処理やロジック検討や追加機能の実装を行ってます。 目次 目次 はじめに CI/CDとは？ CI: Continuous Integration ~ 継続的インテグレーション ~ CD: Continuous Delivery ~継続的デリバリー ~ CD: Continuous Deployment ~ 継続的デプロイ ~ Tools GitLab GitLab CI/CD GitLab Runner GitLab Pages GitLab Container Registry GitLab Badges 静的サイトジェネレータ MkDocs 拡張機能 警告文 注釈 アイコンフォント PlantUML コードハイライト プロジェクトのCI/CDに組み込む ディレクトリ構成 前準備 MkD
同日 いろいろ試したり問題が起きたりしたから追記した PlantUMLを使ってUML図を書くときはAtomにせよVSCodeにせよそれなりにビューアーがあるのでリアルタイムで見る分には基本問題ない ただしドキュメントに挟むときとかあるいはメモがてら残したものをGitで管理して見たいときにちょいっと見るとなるといろいろめんどいしWebから見れない（ChromeのExtensionはあるけど）のでいっそ書いたら勝手に画像を残してくれる環境がほしいと思った。 plantuml.com CIにもよるが、今回はGitHubと連携が楽で無料の範囲でも結構いろいろ使えるCircleCIを使うことにした circleci.com さて同じようなことを考えている人がいるのではないかと思ったが、GitHub Pagesで公開する用途に使うケースが散見されるが単に画像だけ作って欲しいみたいなものは見当たらなかっ
Adways Advent Calendar 2018 14日目の記事です。 http://blog.engineer.adways.net/entry/advent_calendar_2018 こんにちは。2018年度新卒、二度めの登場、佐土原です。 早いのもので前回の記事からあっという間に３ヶ月が経ちました。 実家の母がこれを見つけ一瞬で連絡が飛んできて驚いたことにも懐かしさを帯びはじめる歳月です。母ちゃん今回も書いてるぞ。 さて、今回のブログでは僕の所属するチームで導入し始めたMkDocs + GitLabでのドキュメント管理について書いていこうと思います。 導入の背景 僕の携わるプロダクトも息の長いサービスとなってきており、日常的に「あの話はどうなったんだっけ？」「たしかここはこうだったよね？」という会話も増えてきました。 そこでチームとしてしっかりこれまで/これからの経過をドキュ
某方に布教されてAsciiDocにめっちゃハマった。 AsciiDocって markdownのような軽量マークアップ言語の一種。 markdownより優れている点 markdownより高機能。 困ったらHTMLタグ直書きとかしなくていい。 表セルを結合出来る。 ソースコード、PlantUMLなどをincludeできる。 目次が自動で作られる。 使用可能なアイコンが大量にある。 PDF書き出しした時の見た目が安定&綺麗。 (plantUMLについては過去記事参照) ai-gaminglife.hatenablog.com markdownに劣る点 環境構築がダルい 普及してない はてなブログがasciidocに対応していない 環境構築 windowsを想定。macでも大体変わらない（と思う）。 ruby installerをDLし、実行環境を整える asciidoctorとエクステンションを
以前からテキストベースで仕様書(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 軽量マークアップ言語の
Hugo で PlantUML を描画して埋め込めないものかと調べていると、 Add exec shortcode #796 - gohugoio/hugo・GitHub Hugo の Shortcodes の機能を使って、HTML の生成をフックにしてレンダリングした後に埋め込む、みたいなことをできるようにする議論自体はあったものの進んでいないようで、他の案はないかと調べると PlantUML ではなく mermaid が良いとわかった。 vjeantet/hugo-theme-docdock にあったディレクトリ構成を真似て以下のようにした。 b4b4r07/tellme.tokyo - f8fe64c・GitHub Shortcodes を使って以下のようなシーケンス図を書くと、 {{\< mermaid align="left" \>}} sequenceDiagram parti
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
