On top of system documentation, Hologram allows us to create standard Markdown files that will be browsable within our style guide. These give us a great place to write onboarding docs, project rules and procedures, contact information, or anything else that needs to be captured, organized, and displayed for the team.
Let’s take a quick look at the setup of Hologram and then jump into some documentation examples.
Hologram is a Ruby gem, so we’ll start out by installing the gem to our system:
$ gem install hologram
With the gem installed, we configure Hologram by creating a YAML file with the following: