SlideShare uses cookies to improve functionality and performance, and to provide you with relevant advertising. If you continue browsing the site, you agree to the use of cookies on this website. See our User Agreement and Privacy Policy.
SlideShare uses cookies to improve functionality and performance, and to provide you with relevant advertising. If you continue browsing the site, you agree to the use of cookies on this website. See our Privacy Policy and User Agreement for details.
Successfully reported this slideshow.
Activate your 14 day free trial to unlock unlimited reading.
Lightning Talk: Bending Markdown to Your Will with Your Static Site Generator
A short story about how (Balsamiq) we were able to include content from one markdown file inside another by using the features of our Static Site Generator, Hugo. Prepared as a lightning talk for a Write The Docs SF meetup.
A short story about how (Balsamiq) we were able to include content from one markdown file inside another by using the features of our Static Site Generator, Hugo. Prepared as a lightning talk for a Write The Docs SF meetup.
6.
The Dilemma
How do we write content that can
show up in multiple places?
7.
The Solution
* Hidden from search and other links
8.
Limitations
• Can't include partial content. All or nothing (except front
matter).
• Requires duplicate empty "placeholder" files to insert
content into.
• Standard issues with "single source" models (see, e.g.,
http://idratherbewriting.com/2016/02/11/the-problem-with-
single-source-publishing/)
• Working around some of these though
9.
Wins
• Provides a flexible framework for future product versions
• Allows us to continue to write only (mostly) markdown for
the content (no code needed for includes)