Skip to main content

4 posts tagged with "Docusaurus"

Building, configuring and maintaining documentation sites and help centers on Docusaurus.

View All Tags

Docusaurus accessibility: common WCAG 2.2 issues

· 7 min read
Documentation studio

Docusaurus gives you a reasonably accessible starting point, and most sites then lose some of it. The losses rarely come from the framework itself. They come from custom colors, custom components, a sticky banner someone added for a launch, and years of Markdown written without anyone checking alt text or heading order. This post lists the WCAG 2.2 AA issues we look for first on a Docusaurus site, where each one usually comes from, and how to test for them.

Docusaurus vs MkDocs vs GitBook for help centers

· 7 min read
Documentation studio

Most comparisons of Docusaurus, MkDocs and GitBook are written for developer documentation: API references, SDK guides, versioned technical manuals. A customer help center has different requirements. The people writing it are often support agents rather than engineers, the readers arrive from search with a problem, and the site has to hand off to a human when the article is not enough. This comparison is written for that case.

Zendesk to Docusaurus without losing SEO

· 8 min read
Documentation studio

A Zendesk help center that has been live for a few years usually ranks for a long tail of how-to queries nobody on the team tracks. Moving it to Docusaurus keeps that traffic only if every old article URL answers with a permanent redirect to its new home on the day you switch. How you do that depends on one question most teams have not asked yet: who controls the domain the help center is served from?