Review Docusaurus base paths before exporting documentation

Write the destination before editing configuration

For a hosted example at https://docs.example.com/library/, the origin and the project path have different jobs. Record both in the release notes or review plan. Avoid guessing the base path from the repository name when the actual hosting destination uses another structure.

Also decide whether this is a hosted edition or a portable reading edition. A file opened from local storage does not have the same origin and routing assumptions as a site served over HTTP.

Check the intended settings

The example configuration shows the conceptual split between url and baseUrl. Apply changes within the project’s existing configuration format rather than replacing the entire file with a minimal example. Preserve other settings and have the owner review any public URL changes.

Build the site locally and preview its production output. Inspect image and stylesheet requests as well as navigation links. A homepage that appears correctly can hide broken references on deeper routes.

export default {
  url: 'https://docs.example.com',
  baseUrl: '/library/',
};

Test direct and nested entry points

Open a guide directly using its intended deployed path, then follow a sibling-page link and return through the navigation. Refresh the deep route. These checks expose assumptions that may remain invisible when every visit begins at the homepage.

Look for root-relative references that bypass the configured project prefix. Distinguish missing content from a server routing problem and from incorrect asset URLs. Each requires a different correction, and changing every link indiscriminately can introduce new failures.

Keep reader portability a separate decision

A base-path fix for a hosted site is not evidence that copying an individual HTML page will preserve its styles or interactive components. The generated site may still depend on shared assets and the expected serving environment.

For gitHtml, check the specific .html reading copy with scripts and remote resources at their intended settings. If the task only needs prose and examples, a dedicated standalone export can avoid the hosting assumptions altogether. Record which edition was tested and where it is intended to run.

Read next

• Use Sphinx singlehtml without assuming a self-contained file
• Build Docusaurus for a local documentation review
• Generate TypeDoc HTML from a public entry point
• Control TypeDoc scope before sharing an API reference

All documentation builds and formats guides →