Using PlantUml with Honkit [Docker]

things to do

There were some introductory articles about Honkit, but I didn't find many articles about making PlantUml available.

sample

Code that works https://github.com/tktcorporation/honkit-uml-sample

Preparation around Docker

package.json

{
  "name": "honkit_docker",
  "version": "1.0.0",
  "scripts": {
    "serve": "npx honkit serve",
    "build": "npx honkit build",
    "pdf": "npx honkit pdf"
  },
  "dependencies": {
    "gitbook-plugin-uml": "^1.0.3",
    "honkit": "^3.6.6"
  }
}

Dockerfile

FROM honkit/honkit

RUN apt-get update
#Additional installation for PlantUml
RUN apt-get install -y build-essential openjdk-8-jre graphviz

WORKDIR /doc

COPY ./package.json ./package.json
RUN yarn

COPY . .

CMD [ "npx honkit build" ]

docker-compose.yml

version: "3.7"
services:
  doc:

    build: .
    restart: always
    working_dir: /doc
    volumes:
      - .:/doc:cached
      - /doc/node_modules
    ports:
      - "4000:4000"

Enter the container

$ docker-compose build
$ docker-compose run --service-ports doc /bin/bash

After that, the work will be done in the container unless otherwise specified.

Introduced Honkit

book.json

{
  "plugins": [
    "uml"
  ]
}

init

$ honkit init

write uml


# UML Sample
```uml
@startuml

actor Promoter
actor Entrant

Promoter --> (Create Event)
Promoter -> (Attend Event)

Entrant --> (Find Event)
(Attend Event) <- Entrant

(Attend Event) <.. (Create Member)  : <<include>>

@enduml

serve

$ npx honkit serve

localhost:4000In plantuml.

Recommended Posts

Using PlantUml with Honkit [Docker]
Build PlantUML environment with VSCode + Docker
Use cuda11.0 with pytorch using Docker
Proxy server with squid using docker image
GPU recognition with docker using WSL2 (August 2020)
Try using Kong + Konga with Docker Compose.
Make Volume faster when using Docker with vscode.
Try using another Servlet container Jetty with Docker
Using Pair with OpenJDK
Launch MariaDB with Docker
Rails deploy with Docker
Run Pico with docker
Use Puphpeteer with Docker
Try WildFly with Docker
Use ngrok with Docker
Run Payara with Docker
[Docker] Connection with MySQL
Php settings with Docker
Getting Started with Docker
Disposable PHP with Docker
Install Composer with Docker
Pytorch execution environment with Docker
Use GDAL with Python with Docker
Deploy with EC2 / Docker / Laravel
Try using GloVe with Deeplearning4j
Docker management with VS Code
Try using view_component with rails
Japaneseize using i18n with Rails
Register your own Docker image with ECR using AWS CLI
Run Rails whenever with docker
Get started with DynamoDB with docker
Docker autostart settings with wsl2
[Docker] Rails 5.2 environment construction with docker
Using Mapper with Java (Spring)
Spring Boot starting with Docker
Build docker environment with WSL
Version control CocoaPods with Docker
Web application built with docker (1)
Using Docker from Java Gradle
I tried BIND with Docker
React environment construction with Docker
Build DynamoDB local with Docker
[Docker] Use whenever with Docker + Rails
multi-project docker build using jib
Are you still using anyenv? Let's go more easily with Docker?
Image Spring Boot app using jib-maven-plugin and start it with Docker
Use PlantUML with Visual Studio Code
Rails + MySQL environment construction with Docker
Create a Vue3 environment with Docker!
Node.js environment construction with Docker Compose
Run lambda with custom docker image
Validate arguments using ArgumentCaptor with mockito
Install java with Ubuntu 16.04 based Docker
Build a Node.js environment with Docker
Environment construction with Docker for beginners
[PDO → DB connection with docker, PHP]
Run SQL Server with Docker ToolBox
Folder compression with Scala. Using java.util.zip.ZipOutputStream.
Try using Redmine on Mac docker
Easily Docker Java applications with Jib
I tried using JOOQ with Gradle