# Docusaurus

A Docusaurus 3 documentation site starter with React 19 and TypeScript, built into static HTML, for teams who want docs or a knowledge base written in Markdown and MDX. It includes docs with a generated sidebar, a blog with feeds, a custom home page and light and dark themes.

- Framework: Docusaurus (JavaScript)
- Category: Websites / Docs sites
- Creates: a static site
- Plan: Free
- Price: Free
- Author: Light Cloud
- Page: https://templates.light-cloud.com/websites/docs/docusaurus-docs-starter
- Updated: 2026-11-21

## Features

- Docusaurus 3.10 with the classic preset: docs, blog, pages and theme
- Docs in docs/ with a sidebar generated from the folder structure, in two categories
- Blog with authors.yml, tags.yml, reading time and RSS and Atom feeds
- Custom React home page in src/pages/index.tsx and a standalone Markdown page at /markdown-page
- Light and dark mode that follows the system setting, with a toggle in the navbar
- Docusaurus v4 future flags on, including Rspack builds through @docusaurus/faster
- onBrokenLinks: 'throw', so the build fails on a broken internal link; npm run typecheck for TypeScript

## What you need

- Free plan: it builds to a static site, which the Free plan hosts with no limit on sites
- To run it locally: Node.js 20 or later and npm
- No API keys: it starts with nothing to configure

## About

This is the standard create-docusaurus classic TypeScript site, kept close to upstream so the Docusaurus docs apply as written. docusaurus build renders every docs page, blog post and page to static HTML, and React then hydrates it for client-side navigation. Before you publish, change title, tagline, url, the navbar and footer links and the editUrl values in docusaurus.config.ts, which still point at the Docusaurus defaults. It builds with npm run build into build/, and each push to your copy redeploys.

## Questions

### Is there a free Docusaurus documentation template?

Yes. This starter is MIT licensed and a GitHub template repository, with docs, a blog, a home page and light and dark themes on Docusaurus 3.10 and React 19.

### How do I add a page to the Docusaurus docs?

Create a .md or .mdx file in docs/. The sidebar is generated from the folder, so the page appears on its own; set sidebar_position in the front matter to order it and use _category_.json to label a folder.

### How do I add a blog post in Docusaurus?

Create a file in blog/ named YYYY-MM-DD-slug.mdx with title, authors and tags in the front matter. Authors and tags are defined in blog/authors.yml and blog/tags.yml.

### Does this Docusaurus template have search?

No search is configured. Add Algolia DocSearch through themeConfig.algolia, or a local search plugin, in docusaurus.config.ts.

### Can I host a Docusaurus site without Light Cloud?

Yes. npm run build writes plain files to build/, which any static host serves. If the site lives under a sub-path, set baseUrl in docusaurus.config.ts first.
