This repository hosts a template for Docusaurus, a modern static website generator.
It borrows heavily from the clean theme and styles of the React Native documentation.
It uses @easyops-cn/docusaurus-search-local to enable offline/local search of blogs, documentation and static pages.
It was tested on Docusaurus 3.7.0 with Node.js 24.0.2 and pnpm
10.11.0.
Into an existing Git repository, without creating a nested Git repository:
$ pnpm create docusaurus [name] \
--git-strategy=copy https://github.com/franckrasolo/docusaurus-template
# remove unnecessary files and directories
$ cd [name] && pnpm zap
See the Docusaurus documentation on the available Git strategies.
$ pnpm start
This command starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.
Please note that local search is not available during local development.
$ pnpm build
This command generates static contents into the build
directory and can be served
using any static contents hosting service.
Locally, simply run:
$ pnpm serve