Editing the Book

• Having created the book
• Run ./watch.sh
• Keep the SUMMARY.md file open in order to add new pages
  • Ctrl + Click will open the editor for a page link
• If you edit any file under the md folder you should see the book regenerated in the terminal where the watch.sh is running.
  • The message The mdbook-plus preprocessor not running ... can be ignored.

  plantuml
@startuml
autonumber "<b>[0]"
skinparam responseMessageBelowArrow true
title Example Sequence Diagram
Thread1 -> Thread2: Blocking Request
Thread1 <-- Thread2: Response
Thread1 ->> Thread2: Non-Blocking Message
Thread1 -> Thread1: Sometimes I talk to myself
note right
Maybe something you sent on a channel
end note
alt sunny day
Thread1 -[#green]>> Thread2: green arrow
else it rained
loop 1000 times
Thread1 -[#blue]>> Thread2: blue arrow
end
else it snowed
Thread1 ->> Thread2: //snowing italics//
end
@enduml

Supporting Diagrams

Plantuml is used to generate supporting diagrams. Using mdbook-plantuml postprocessor we can use markdown to represent the diagrams and a corresponding image file will be generated upon book generation.

Book Layout