What is a static site generator?¶
Mass market content management systems (CMSs) like Wordpress, Wix, and Weebly dynamically generate websites-- webpages are assembled from database components as a user visits the page. In contrast, a static website is simply a set of HTML files and some CSS.
A static site generator (SSG), then, is simply a tool to generate the HTML and CSS files that comprise a static website. Content is generally written in Markdown, run through a templating process, and then poof-- you have a set of HTML files!
SSGs can be easier to use and customize and typically more secure than CMSs that dynamically generate websites (e.g., Wordpress, Wix), but provide less structure than something like DITA XML. For projects in which reuse, structure, consistency, and translation and localization are critical, DITA XML and a component content management system is probably a better choice.
While static site generators may not be right for every project, they're increasingly popular for small documentation sites or projects that require frequent updates. For example, Andrew Etter in Modern Technical Writing strongly advocates for the use of SSGs for software documentation.
"...you provide a static site generator with content (lightweight markup) and a theme (templated HTML and CSS), and it processes everything into a working website. To update the site, just modify the content and process everything again."
Learn more about SSGs in tech comm¶
- Tom Johnson on *Static site generators start to replace web publishing platforms like Wordpress
- Jessica Parsons' Read the Docs Workshop: Static Site Generators, What, Why, and How
Popular static site generators¶
There are TONS of SSGs and templates. Although blogging is probably the most common use case, some SSGs have huge communities of technical communicators that develop themes and plug-ins specifically with technical communication in mind. Here are a few: