Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / tools / Let’s Find Out: When Do Static Site Generators Do Rendering?

May 3, 2023 by annegentle

Let’s Find Out: When Do Static Site Generators Do Rendering?

Let’s Find Out: When Do Static Site Generators Do Rendering?

Pre-rendering and progressive rendering are two techniques used by static site generators to improve website performance and user experience. Rendering is generating HTML. In the case of Static Site Generators, this is not the same as web page rendering as explained by Constructing the Object Model on the web.dev site.

static site generators: pre-rendering and progressive rendering; Docs Like Code

Here’s a brief overview of two additional types of rendering:

  1. Pre-rendering: Pre-rendering involves generating the HTML, CSS, and JavaScript for a website at build time before the user requests the page. When a user visits the website, the server can serve the pre-rendered HTML rather than generate it on the fly. Pre-rendering can significantly improve the speed and performance of a website, as it eliminates the delay caused by rendering the page on the server.
  2. Progressive rendering: Progressive rendering, on the other hand, involves generating and serving the HTML, CSS, and JavaScript for a website in stages as the user requests the page. For example, the server might first serve a basic HTML page with minimal styling and functionality and then progressively add more content and features as the user interacts with the page. Progressive rendering can help reduce a website’s initial load time, as the user can start interacting with the page before all the content and features are loaded.

When evaluating a Static Site Generator (SSG) it’s best to understand the performance requirements for your docs site on both the amount of content you need to render immediately and that which can wait in the user’s browser. In the case of NextJS and Gatsby, once the app’s JavaScript is loaded to the client’s browser, JavaScript code picks up the work, but initially, a pre-rendered initial static HTML is available for reading. NextJS and Gatsby are built on the base React frontend framework.

Considerations for SSGs and technical documentation

In summary, pre-rendering involves generating the entire website at build time, while progressive rendering involves developing and serving the website in stages as the user interacts with it. Both techniques can help improve a website’s performance and user experience, but they have different strengths and use cases. Pre-rendering is best suited for websites with a lot of content and features that can be generated beforehand. In contrast, progressive rendering is best suited for websites that need to load quickly and allow the user to start interacting with the page as soon as possible. Pre-rendering is likely best for most documentation sites. Documentation built into a dashboard may benefit from tight integration and progressive rendering. Like the considerations when Evaluating print, PDF, or epub output, or evaluating themes, you want to evaluate rendering when looking into static site generators.

Related

Filed Under: tools Tagged With: Gatsby, hugo, SSG, static site

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in