Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.53 KB

README.md

File metadata and controls

70 lines (52 loc) · 2.53 KB
Raw

gravizool

Small Gravizo tool for encoding and decoding GitHub Markdown files based on the new GitHub Flavored Markdown Spec. Makes it possible to use and view UML diagrams on GitHub and directly in pull requests for architectural reviews, module documentation etc.

It has the advantage over the Gravizo approach that it can still be rendered locally and images can be seen directly in pull requests.

Usage

$ ./gravizool -h
Usage of ./gravizool:
  -b	Backup the GitHub Markdown file (default true)
  -d string
    	Decode the GitHub Markdown file
  -e string
    	Encode the GitHub Markdown file
  -f string
    	Fix the GitHub Markdown file
  -v	Print the program version

Workflow

  • Decode the Markdown file: gravizool -d README.md
  • Change the Markdown file. Both VS Code and Atom editor supports on the fly Markdown rendering (right click on the file and select "Markdown Preview")
  • Fix the Markdown file in case of rendering issues: gravizool -f README.md
  • Encode the Markdown file again: gravizool -e README.md
  • Commit to GitHub

README.md files can be viewed in pull requests by pressing the "View" button under the "Files changed" tab.

Example

If we add the Gravizo example below using plantuml syntax to a README.md it will not render in e.g. Atom due to Gravizo incompatibilities:

<img src='https://g.gravizo.com/svg?
@startuml
class FooBar {
  String foo
  void bar()
}
@enduml'>

To fix these issues use the gravizool fix (-f) option which will convert the example to the following and make it render:

<img src='https://g.gravizo.com/svg?;
@startuml;
class FooBar {;
  String foo;
  void bar();
};
@enduml'>

Before uploading the README.md to GitHub it needs to be encoded with the gravizool encode (-e) option which will convert the example to:

<img src='https://g.gravizo.com/svg?%3B%0A%40startuml%3B%0Aclass%20FooBar%20{%3B%0A%20%20String%20foo%3B%0A%20%20void%20bar%28%29%3B%0A}%3B%0A%40enduml'>

The example will now be rendered on GitHub and can be seen directly in e.g. the pull request:

Limitations

  • Currently only works with SVG (searches for .gravizo.com/svg? and enduml)