https://github.com/franckrasolo/docusaurus-template

A Docusaurus template using theme and styles of the React Native documentation
https://github.com/franckrasolo/docusaurus-template

devenv docusaurus docusaurus-template docusaurus-v3 nix node-js nodejs pnpm react-native static-site-generation typescript typescript-react

Last synced: about 1 month ago
JSON representation

A Docusaurus template using theme and styles of the React Native documentation

• Host: GitHub
• URL: https://github.com/franckrasolo/docusaurus-template
• Owner: franckrasolo
• License: mit
• Created: 2025-05-23T10:32:57.000Z (about 1 year ago)
• Default Branch: trunk
• Last Pushed: 2025-05-23T12:31:40.000Z (about 1 year ago)
• Last Synced: 2025-06-28T11:12:52.560Z (11 months ago)
• Topics: devenv, docusaurus, docusaurus-template, docusaurus-v3, nix, node-js, nodejs, pnpm, react-native, static-site-generation, typescript, typescript-react
• Language: SCSS
• Homepage:
• Size: 790 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Docusaurus Template

[![Built with Nix and devenv](https://img.shields.io/badge/Built_with-devenv-43329C.svg?style=flat&logo=nixos&logoColor=white&label=Nix%20with&labelColor=5277C3&suffix=devenv)](https://devenv.sh)

This repository hosts a template for [Docusaurus](https://docusaurus.io/), a modern static website generator.

It borrows heavily from the clean theme and styles of the [React Native](https://reactnative.dev/) documentation.

It uses [@easyops-cn/docusaurus-search-local](https://github.com/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.*

![banner](banner-readme.png)

### Installation

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](https://docusaurus.io/docs/api/misc/create-docusaurus#git-strategy).

### Local Development

```

$ 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.

### Build

```shell

$ pnpm build

```

This command generates static contents into the `build` directory and can be served

using any static contents hosting service.

Locally, simply run:

```shell

$ pnpm serve

```