Home
Categories
EXPLORE
True Crime
Comedy
Society & Culture
Business
Sports
Technology
News
About Us
Contact Us
Copyright
© 2024 PodJoint
Podjoint Logo
US
00:00 / 00:00
Sign in

or

Don't have an account?
Sign up
Forgot password
https://is1-ssl.mzstatic.com/image/thumb/Podcasts126/v4/c9/36/2a/c9362afa-b0ca-3476-ce53-75e32d3e3990/mza_16804427041338478835.jpg/600x600bb.jpg
Write Open Source
Rolfe Dlugy-Hegwer
4 episodes
4 hours ago
A behind-the-scenes look at technical writing for open-source software. We connect with writers and other doc experts to hear their stories about overcoming challenges, working on special projects, and learning new methods.
Show more...
Technology
RSS
All content for Write Open Source is the property of Rolfe Dlugy-Hegwer and is served directly from their servers with no modification, redirects, or rehosting. The podcast is not affiliated with or endorsed by Podjoint in any way.
A behind-the-scenes look at technical writing for open-source software. We connect with writers and other doc experts to hear their stories about overcoming challenges, working on special projects, and learning new methods.
Show more...
Technology
https://d3t3ozftmdmh3i.cloudfront.net/production/podcast_uploaded_episode400/18630209/18630209-1644778063139-1bf01158333cc.jpg
Diagrams help your readers understand. Chris Metz gives "A brief demonstration of Mermaid.js"
Write Open Source
6 minutes 6 seconds
3 years ago
Diagrams help your readers understand. Chris Metz gives "A brief demonstration of Mermaid.js"

This episode is a video demo, which you can see here on spotify or vimeo.  

Chris Metz is a freelance solutions architect and tech writer with cloud and emerging technologies based in Danville, California, near the San Francisco Bay Area. 

In "A brief demonstration of Mermaid.js," Chris  shows us how to use Mermaid.js to add diagrams to your documentation. 

Chris recently added the Diagram Guide to the Kubernetes.io website, where he is a regular contributor.

To me, this diagrams-as-code has several benefits:

  • It separates the content of the diagrams from how they are presented, which means that all your diagrams have a consistent look.
  • The search results will include your diagrams when you edit and search your docs.
  • Writers and developers can directly create diagrams without using specialized tools or creating asset files that get lost.
Write Open Source
A behind-the-scenes look at technical writing for open-source software. We connect with writers and other doc experts to hear their stories about overcoming challenges, working on special projects, and learning new methods.